Skip to content

Commit c49fe50

Browse files
authored
Create CONTRIBUTING.md
1 parent 02aa43f commit c49fe50

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed

CONTRIBUTING.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Contributing
2+
Contributions, questions and comments, pull requests are all welcome.
3+
**Note**: if you want to change the structure, please open an issue and we will discuss it, but if you have
4+
an interesting questions or answers, please make pull request.
5+
6+
## Getting Started - right way
7+
8+
* Make sure you have a [GitHub account](https://github.com/signup/free).
9+
* Submit a Github issue for this Repo.
10+
* Clearly describe the issue.
11+
* Fork the repository on GitHub.
12+
13+
## Making Changes
14+
15+
* Create a topic branch from where you want to base your work.
16+
* This is usually the master branch.
17+
* Only target release branches if you are certain your fix must be on that
18+
branch.
19+
* To quickly create a topic branch based on master, run `git checkout -b
20+
fix/my_awesome_fix`. Please avoid working directly on the
21+
`master` branch.
22+
* Make commits of logical and atomic units.
23+
* Check for unnecessary whitespace with `git diff --check` before committing.
24+
* Make sure your commit messages are in the proper format:
25+
* Short (50 chars or less) summary of changes.
26+
* Start the line with "Fix", "Add", "Change" instead of "Fixed", "Added", "Changed".
27+
* Capitalize the subject line.
28+
* Push chages
29+
* Create Pull Request
30+
31+
Thanks to all these cool people :hand::
32+
[Ken Hawkins](https://github.com/khawkins98)

0 commit comments

Comments
 (0)