Skip to content

Commit 4f987a2

Browse files
committed
Add CONTRIBUTING.md
1 parent 4c4c0d9 commit 4f987a2

File tree

1 file changed

+41
-0
lines changed

1 file changed

+41
-0
lines changed

CONTRIBUTING.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
Contributing
2+
============
3+
4+
Contributions are welcome!
5+
6+
**Please carefully read this page to make the code review process go as smoothly as possible and to maximize the likelihood of your contribution being merged.**
7+
8+
## Bug Reports
9+
10+
For bug reports or requests [submit an issue](https://github.com/donnemartin/system-design-primer/issues).
11+
12+
## Pull Requests
13+
14+
The preferred way to contribute is to fork the
15+
[main repository](https://github.com/donnemartin/system-design-primer) on GitHub.
16+
17+
1. Fork the [main repository](https://github.com/donnemartin/system-design-primer). Click on the 'Fork' button near the top of the page. This creates a copy of the code under your account on the GitHub server.
18+
19+
2. Clone this copy to your local disk:
20+
21+
$ git clone [email protected]:YourLogin/system-design-primer.git
22+
$ cd system-design-primer
23+
24+
3. Create a branch to hold your changes and start making changes. Don't work in the `master` branch!
25+
26+
$ git checkout -b my-feature
27+
28+
4. Work on this copy on your computer using Git to do the version control. When you're done editing, run the following to record your changes in Git:
29+
30+
$ git add modified_files
31+
$ git commit
32+
33+
5. Push your changes to GitHub with:
34+
35+
$ git push -u origin my-feature
36+
37+
6. Finally, go to the web page of your fork of the `system-design-primer` repo and click 'Pull Request' to send your changes for review.
38+
39+
### GitHub Pull Requests Docs
40+
41+
If you are not familiar with pull requests, review the [pull request docs](https://help.github.com/articles/using-pull-requests/).

0 commit comments

Comments
 (0)