Skip to content

Commit 634bd98

Browse files
committed
docs: only use dev-branch as PR target. Fixed #367
1 parent 32f7c26 commit 634bd98

File tree

2 files changed

+29
-41
lines changed

2 files changed

+29
-41
lines changed

CONTRIBUTING.md

+27-39
Original file line numberDiff line numberDiff line change
@@ -97,66 +97,54 @@ We like feature requests but make sure that it can be seen within the goals of t
9797

9898
Good pull requests - patches, improvements, new features - are a fantastic help. Thanks for taking the time to contribute.
9999

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.
101101

102102
**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)
105-
and/or [`/materialize/js/`](https://github.com/materializecss/materialize/tree/main/js) instead.
103+
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.
106104

107105
### Documentation
108106

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.
112108

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.
114110

115-
Adhering to the following process is the best way to get your work included in the project:
111+
---
116112

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
121-
git clone https://github.com/<your-username>/materialize.git
122-
# Navigate to the newly cloned directory
123-
cd materialize
124-
# Assign the original repo to a remote called "upstream"
125-
git remote add upstream https://github.com/materializecss/materialize.git
126-
```
113+
### Submitting your Pull Request
127114

128-
2. Go to Starting Branch and get latest changes:
129-
First make yourself clear what you want to provide: Bugfix or Feature? The principle for both types of changes is the same: "First update, then work"
130-
131-
2.1. Bugfix
115+
Adhering to the following process is the best way to get your work included in the project:
132116

133-
Get the latest changes from upstream main-branch:
117+
1. [Fork](https://help.github.com/fork-a-repo/) the project, clone your fork, and configure the remotes:
134118
```bash
135-
git checkout main # go to the main branch
136-
git pull upstream main # pull from the community-repo main-branch
119+
# Clone your fork of the repo into the current directory
120+
git clone https://github.com/<your-username>/materialize.git
121+
# Navigate to the newly cloned directory
122+
cd materialize
123+
# Assign the original repo to a remote called "upstream"
124+
git remote add upstream https://github.com/materializecss/materialize.git
137125
```
138126

139-
2.2. Feature
127+
2. Get latest changes ("First update, then work")
140128

141-
Get the latest changes from upstream development-branch:
129+
Pull from upstream development-branch:
142130
```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
145135
```
146136

147137
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+
```
151141

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 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.
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
154144

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.
157146
```bash
158-
git pull [--rebase] upstream main # bugfix
159-
git pull [--rebase] upstream v2-dev # feature
147+
git pull [--rebase] upstream v2-dev
160148
```
161149

162150
6. Push your topic branch up to your fork:

package-lock.json

+2-2
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)