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: CONTRIBUTING.md
+27-39
Original file line number
Diff line number
Diff line change
@@ -97,66 +97,54 @@ We like feature requests but make sure that it can be seen within the goals of t
97
97
98
98
Good pull requests - patches, improvements, new features - are a fantastic help. Thanks for taking the time to contribute.
99
99
100
-
**Please ask first** before working on any significant pull request, otherwise you risk spending a lot of time working on something that the project's developers might not want to merge into the project.
100
+
**Please ask first**and open a new issue before working on any significant pull request, otherwise you risk spending a lot of time working on something that the project's developers might not want to merge into the project.
101
101
102
102
**Do not edit `materialize.css`, or `materialize.js`
103
-
directly!** Those files are automatically generated. You should edit the
104
-
source files in [`/materialize/sass/`](https://github.com/materializecss/materialize/tree/main/sass)
directly!** Those files are automatically generated. You should edit the source files in [`sass`](https://github.com/materializecss/materialize/tree/v2-dev/sass) and [`src`](https://github.com/materializecss/materialize/tree/v2-dev/src) instead.
106
104
107
105
### Documentation
108
106
109
-
When contributing to Materialize's documentation, you should edit the documentation source files in
110
-
[the `/materialize/pug/page-contents/` directory of the `main` branch](https://github.com/materializecss/materialize/tree/main/pug).
111
-
**Do not edit the `gh-pages` branch.** That branch is generated from the documentation source files and is managed separately by the Materialize maintainers.
107
+
When contributing to the documentation, you should edit the documentation source files in the [`pug/page-contents/`](https://github.com/materializecss/materialize/tree/v2-dev/pug) directory of the `v2-dev` branch.
112
108
113
-
### Submitting Your Pull Request
109
+
**Do not edit the `gh-pages` branch directly.** That branch is generated from the documentation source files and is managed separately by the Materialize maintainers.
114
110
115
-
Adhering to the following process is the best way to get your work included in the project:
111
+
---
116
112
117
-
1.[Fork](https://help.github.com/fork-a-repo/) the project, clone your fork,
118
-
and configure the remotes:
119
-
```bash
120
-
# Clone your fork of the repo into the current directory
Get the latest changes from upstream development-branch:
129
+
Pull from upstream development-branch:
142
130
```bash
143
-
git checkout v2-dev # go to the dev branch
144
-
git pull upstream v2-dev # pull from the community-repo dev-branch
131
+
# go to local dev branch
132
+
git checkout v2-dev
133
+
# pull from online-repo dev-branch
134
+
git pull upstream v2-dev
145
135
```
146
136
147
137
3. Create a new topic branch to contain your work:
148
-
```bash
149
-
git checkout -b <topic-branch-name>
150
-
```
138
+
```bash
139
+
git checkout -b <topic-branch-name>
140
+
```
151
141
152
-
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. Failing to do this makes your commits unlikely to be merged into the main project.
153
-
> You can use `npm run commit` to help you formatting the message, or use [commitlint.io](https://commitlint.io) if you are not editing locally
142
+
4. Commit your changes in logical chunks with messages inenglish. 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. Failing to do this makes your commits unlikely to be merged.
143
+
> You can use `npm run commit` to help you formatting the message, or use [commitlint.io](https://commitlint.io) if you are not editing locally
154
144
155
-
5. Locally merge (or rebase) the upstream branch into your topic branch.
156
-
If in the meantime anything has changed in the community-repo you can add this changes locally into your repo.
145
+
5. Locally merge (or rebase) the upstream branch into your topic branch. If in the meantime anything has changed in the online-repo you can add this changes locally into your repo.
0 commit comments