Skip to content

Commit 904b708

Browse files
authored
Create CONTRIBUTING.md
1 parent a74de4a commit 904b708

File tree

1 file changed

+57
-0
lines changed

1 file changed

+57
-0
lines changed

CONTRIBUTING.md

+57
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
# How to contribute
2+
3+
:+1::tada: First off, thanks for taking the time to contribute! :tada::+1:
4+
5+
It's people like you that make open source such powerful. Following these guidelines helps keep the project
6+
maintainable, easy to contribute to, and more secure. Thank you for taking the
7+
time to follow this guide.
8+
9+
## Where to start
10+
11+
There are many ways to contribute. You can fix a bug, improve the documentation,
12+
submit bug reports and feature requests, or take a first shot at a feature you
13+
need for yourself.
14+
15+
Pull requests are necessary for all contributions of code or documentation.
16+
17+
## New to open source?
18+
19+
If you're **new to open source** and not sure what a pull request is, welcome!!
20+
We're glad to have you! All of us once had a contribution to make and didn't
21+
know where to start.
22+
23+
Even if you don't write code for your job, don't worry, the skills you learn
24+
during your first contribution to open source can be applied in so many ways,
25+
you'll wonder what you ever did before you had this knowledge. It's worth
26+
learning.
27+
28+
[How To Contribute to Open Source](https://contributing.md/how-to-contribute-to-open-source/)
29+
30+
## Fixing a typo, or a one or two line fix
31+
32+
Many fixes require little effort or review, such as:
33+
34+
> - Spelling / grammar, typos, white space and formatting changes
35+
> - Comment clean up
36+
> - Change logging messages or debugging output
37+
> These small changes can be made directly in GitHub if you like.
38+
39+
Click the pencil icon in GitHub above the file to edit the file directly in
40+
GitHub. This will automatically create a fork and pull request with the change.
41+
See:
42+
[Make a small change with a Pull Request](https://www.freecodecamp.org/news/how-to-make-your-first-pull-request-on-github/)
43+
44+
## Bug fixes and features
45+
46+
For something that is bigger than a one or two line fix, go through the process
47+
of making a fork and pull request yourself:
48+
49+
> 1. Create your own fork of the code
50+
> 2. Clone the fork locally
51+
> 3. Make the changes in your local clone
52+
> 4. Push the changes from local to your fork
53+
> 5. Create a pull request to pull the changes from your fork back into the
54+
> upstream repository
55+
> Please use clear commit messages so we can understand what each commit does.
56+
> We'll review every PR and might offer feedback or request changes before
57+
> merging.

0 commit comments

Comments
 (0)