You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/PULL_REQUEST_TEMPLATE.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,7 +14,7 @@
14
14
## Checklist:
15
15
<!-- Go over all the following points, and put an `x` in all the boxes that apply. If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
16
16
17
-
-[ ] I have read the **[CONTRIBUTING document](https://github.com/materializecss/materialize/blob/master/CONTRIBUTING.md)**.
17
+
-[ ] I have read the **[CONTRIBUTING document](https://github.com/materializecss/materialize/blob/main/CONTRIBUTING.md)**.
18
18
-[ ] My change requires a change to the documentation.
19
19
-[ ] I have updated the documentation accordingly.
Copy file name to clipboardExpand all lines: CHANGELOG.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,5 @@
1
1
# Changelog
2
-
All notable changes to this project will be documented in this file. For changes made before this fork, please refer to [HISTORY.md](https://github.com/materializecss/materialize/blob/v1-dev/HISTORY.md).
2
+
All notable changes to this project will be documented in this file. For changes made before this fork, please refer to [HISTORY.md](https://github.com/materializecss/materialize/blob/main/HISTORY.md).
3
3
4
4
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
5
5
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
@@ -8,7 +8,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
8
8
9
9
### Added
10
10
11
-
- Nightly builds of the latest code available through github actions ([Easy link for the latest build](https://nightly.link/materializecss/materialize/workflows/nightly/v1-dev/build)) ([58d18003](https://github.com/materializecss/materialize/commit/58d180036374f2b38a244e5e96c33838ce185220))
11
+
- Nightly builds of the latest code available through github actions ([Easy link for the latest build](https://nightly.link/materializecss/materialize/workflows/nightly/main/build)) ([58d18003](https://github.com/materializecss/materialize/commit/58d180036374f2b38a244e5e96c33838ce185220))
12
12
- Added support for text input suffix icons ([3e516e5b](https://github.com/materializecss/materialize/commit/3e516e5b322e4f8c7299cc37504389d0ddbb1ed6))
-[Using the issue tracker](#using-the-issue-tracker)
10
10
-[Issues and labels](#issues-and-labels)
11
11
-[Bug reports](#bug-reports)
12
+
-[Guidelines for bug reports:](#guidelines-for-bug-reports)
12
13
-[Feature Requests](#feature-requests)
13
14
-[Code Examples](#code-examples)
14
15
-[Pull Requests](#pull-requests)
15
16
-[Documentation](#documentation)
16
17
-[Submitting Your Pull Request](#submitting-your-pull-request)
17
18
-[Translations](#translations)
18
-
-[Jasmine Testing Guide](#jasmine-testing-guide)
19
+
-[Jasmine Testing Guide:](#jasmine-testing-guide)
20
+
-[Starting Out](#starting-out)
21
+
-[Writing Tests](#writing-tests)
22
+
-[Useful Jasmine Tips](#useful-jasmine-tips)
23
+
-[License](#license)
19
24
20
25
## Introduction
21
26
Please take a moment to review this document in order to make the contribution
@@ -31,8 +36,8 @@ patches and features.
31
36
Before you now get lost in the repository, here are a few starting points for you to check out. You might find that others have had similar questions or that your question rather belongs in one place than another.
@@ -56,12 +61,11 @@ Our bug tracker utilizes several labels to help organize and identify issues. He
56
61
57
62
-`component:*` - Each component has been provided a label. Add the labels for any component the issue is triggered by.
58
63
-`confirmed` - Issues that have been confirmed with a reduced test case and identify a bug in Materialize.
59
-
-`css` - Issues stemming from our compiled CSS or source Sass files.
64
+
-`css/sass` - Issues stemming from our compiled CSS or source Sass files.
60
65
-`js` - Issues stemming from our compiled or source JavaScript files.
61
-
-`docs` - Issues for improving or updating our documentation.
62
-
-`help-wanted` - Issues we need or would love help from the community to resolve.
66
+
-`documentation` - Issues for improving or updating our documentation.
67
+
-`helpwanted` - Issues we need or would love help from the community to resolve.
63
68
-`meta` - Issues with the project itself or our GitHub repository.
64
-
-`on-hold` Issues or pull that should be worked on, but for any reason it won't be worked on/accepted as a PR anytime soon.
65
69
66
70
For a complete look at our labels, see the [project labels page](https://github.com/materializecss/materialize/labels).
67
71
@@ -75,7 +79,7 @@ Good bug reports are extremely helpful! Unclear issues with little explanations
75
79
76
80
1.**Use the GitHub issue search** - check if the issue has already been reported.
77
81
78
-
2.**Check if the issue has been fixed** - try to reproduce it using the latest `master` or development branch in the repository.
82
+
2.**Check if the issue has been fixed** - try to reproduce it using the latest commited branch in the repository. The [`main`](https://github.com/materializecss/materialize/tree/main) branch is stable, other branches are used for development.
79
83
80
84
3.**Isolate the problem**— create a [reduced test case](https://css-tricks.com/reduced-test-cases/) using **our**[Codepen template](#code-examples).
81
85
@@ -88,9 +92,9 @@ We like feature requests but make sure that it can be seen within the goals of t
88
92
### Code Examples
89
93
90
94
- Issues without a [Codepen](#code-examples) (where applicable) will be closed or ignored.
91
-
- Use this [Codepen](http://codepen.io/Dogfalo/pen/xbzPQV) to illustrate your problem.
95
+
- Use this [Codepen](https://codepen.io/pen/?template=MRNObV) to illustrate your problem.
92
96
93
-
## Pull requests
97
+
## Pull Requests
94
98
95
99
Good pull requests - patches, improvements, new features - are a fantastic help. Thanks for taking the time to contribute.
When contributing to Materialize's documentation, you should edit the documentation source files in
107
-
[the `/materialize/jade/page-contents/` directory of the `master` branch](https://github.com/materializecss/materialize/tree/master/jade).
111
+
[the `/materialize/pug/page-contents/` directory of the `master` branch](https://github.com/materializecss/materialize/tree/master/pug).
108
112
**Do not edit the `gh-pages` branch.** That branch is generated from the documentation source files and is managed separately by the Materialize maintainers.
109
113
110
114
### Submitting Your Pull Request
@@ -136,7 +140,7 @@ Adhering to the following process is the best way to get your work included in t
136
140
git checkout -b <topic-branch-name>
137
141
```
138
142
139
-
4. Commit your changes in logical chunks with messages written in english. Please adhere to these [git commit message guidelines](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html) or your code is unlikely be merged into the main project.
143
+
4. Commit your changes in logical chunks with messages written in English. Please adhere to these [git commit message guidelines](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)and use [conventional commit format](https://github.com/conventional-changelog/commitlint/#what-is-commitlint) in your commit messages (or use `npm run commit` to make your life easier). Failing to do this makes your commits unlikely to be merged into the main project.
140
144
141
145
5. Locally merge (or rebase) the upstream development branch into your topic branch:
142
146
@@ -150,19 +154,18 @@ Adhering to the following process is the best way to get your work included in t
150
154
git push origin <topic-branch-name>
151
155
```
152
156
153
-
7.[Open a Pull Request](https://help.github.com/articles/using-pull-requests/) with a clear title and description against the `master`branch. Reference any open issue in the description so it is automatically linked. Try and keep your commit history clean and concise. Once you submit your pull request, [Travis CI](https://travis-ci.org/materializecss/materialize) will automatically run your tests and will show a checkmark to show that all the tests have passed. Once this is done, we’ll review your tests and code and make comments if there are issues or things we think could be improved. Then once everything looks good we’ll merge the code in!
157
+
7.[Open a Pull Request](https://help.github.com/articles/using-pull-requests/) with a clear title and description against the current development branch, usually `vX.X.X-dev`. Reference any open issue in the description so it is automatically linked. Try and keep your commit history clean and concise. Once you submit your pull request, Github Actions will automatically run your tests and will show a checkmark to show that all the tests have passed. Once this is done, we’ll review your tests and code and make comments if there are issues or things we think could be improved. Then once everything looks good we’ll merge the code in!
154
158
155
159
## Translations
156
160
157
-
If you want to help us translate the documentation into other languages, please send us an email at [email protected] telling us which language team you want to join. We use [Transifex](https://www.transifex.com) as our localization platform and we will send you an invite there.
161
+
If you want to help us translate the documentation into other languages, you can visit the [translation discussion here](https://github.com/materializecss/materialize/discussions/182).
After `npm install`, you can run `npm test` and it will run the tests. If you get any errors and have not made any changes, it means you have not installed the proper dependencies.
0 commit comments