Skip to content

Commit b8071fc

Browse files
committed
docs: Updated the CONTRIBUTING.md to correct some mistakes and ask people to PR to dev
1 parent a131d8f commit b8071fc

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

CONTRIBUTING.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
# How to contribute to cc-downloader?
2+
23
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.0-4baaaa.svg)](CODE_OF_CONDUCT.md)
34

45
`cc-downloader` is an open source project, so all contributions and suggestions are welcome.
@@ -12,6 +13,7 @@ In order to facilitate healthy, constructive behavior in an open and inclusive c
1213
our [code of conduct](CODE_OF_CONDUCT.md).
1314

1415
## How to work on an open Issue?
16+
1517
You have the list of open Issues at: [https://github.com/commoncrawl/cc-downloader/issues](https://github.com/commoncrawl/cc-downloader/issues)
1618

1719
Some of them may have the label `help wanted`: that means that any contributor is welcomed!
@@ -36,13 +38,14 @@ If you would like to work on any of the open Issues:
3638
git remote add upstream git@github.com:commoncrawl/cc-downloader.git
3739
```
3840

39-
3. Create a new branch to hold your development changes:
41+
3. Switch to the `dev` branch and then create a new branch to hold your development changes:
4042

4143
```bash
44+
git checkout dev
4245
git checkout -b a-descriptive-name-for-my-changes
4346
```
4447

45-
**do not** work on the `main` branch.
48+
**do not** work on the `main` or `dev` branches.
4649

4750
4. Develop the features on your branch.
4851

@@ -58,17 +61,16 @@ If you would like to work on any of the open Issues:
5861
5962
```bash
6063
git fetch upstream
61-
git rebase upstream/main
64+
git rebase upstream/dev
6265
```
6366
64-
9. Once you are satisfied, push the changes to your fork repo using:
67+
6. Once you are satisfied, push the changes to your fork repo using:
6568
6669
```bash
6770
git push -u origin a-descriptive-name-for-my-changes
6871
```
6972
70-
Go the webpage of your fork on GitHub. Click on "Pull request" to send your to the project maintainers for review.
71-
73+
Go the webpage of your fork on GitHub. Click on "Pull request" to send your to the project maintainers for review, and select the `dev` branch as the brach you'd like to merge your changes into.
7274

7375
Thank you for your contribution!
7476

0 commit comments

Comments
 (0)