Skip to content

Commit 9f9d576

Browse files
authoredApr 6, 2018
Create CONTRIBUTING.md
1 parent 713e044 commit 9f9d576

File tree

1 file changed

+152
-0
lines changed

1 file changed

+152
-0
lines changed
 

‎CONTRIBUTING.md

+152
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,152 @@
1+
2+
# Contributing to this project
3+
4+
Please take a moment to review this document in order to make the contribution
5+
process easy and effective for everyone involved.
6+
7+
Following these guidelines helps to communicate that you respect the time of
8+
the developers managing and developing this open source project. In return,
9+
they should reciprocate that respect in addressing your issue or assessing
10+
patches and features.
11+
12+
13+
## Using the issue tracker
14+
15+
The issue tracker is the preferred channel for [bug reports](#bugs),
16+
[features requests](#features) and [submitting pull
17+
requests](#pull-requests), but please respect the following restrictions:
18+
19+
* Please **do not** use the issue tracker for personal support requests (use
20+
[Stack Overflow](http://stackoverflow.com) or IRC).
21+
22+
* Please **do not** derail or troll issues. Keep the discussion on topic and
23+
respect the opinions of others.
24+
25+
26+
<a name="bugs"></a>
27+
## Bug reports
28+
29+
A bug is a _demonstrable problem_ that is caused by the code in the repository.
30+
Good bug reports are extremely helpful - thank you!
31+
32+
Guidelines for bug reports:
33+
34+
1. **Use the GitHub issue search** &mdash; check if the issue has already been
35+
reported.
36+
37+
2. **Check if the issue has been fixed** &mdash; try to reproduce it using the
38+
latest `master` or development branch in the repository.
39+
40+
3. **Isolate the problem** &mdash; create a [reduced test
41+
case](http://css-tricks.com/reduced-test-cases/) and a live example.
42+
43+
A good bug report shouldn't leave others needing to chase you up for more
44+
information. Please try to be as detailed as possible in your report. What is
45+
your environment? What steps will reproduce the issue? What browser(s) and OS
46+
experience the problem? What would you expect to be the outcome? All these
47+
details will help people to fix any potential bugs.
48+
49+
Example:
50+
51+
> Short and descriptive example bug report title
52+
>
53+
> A summary of the issue and the browser/OS environment in which it occurs. If
54+
> suitable, include the steps required to reproduce the bug.
55+
>
56+
> 1. This is the first step
57+
> 2. This is the second step
58+
> 3. Further steps, etc.
59+
>
60+
> `<url>` - a link to the reduced test case
61+
>
62+
> Any other information you want to share that is relevant to the issue being
63+
> reported. This might include the lines of code that you have identified as
64+
> causing the bug, and potential solutions (and your opinions on their
65+
> merits).
66+
67+
68+
<a name="features"></a>
69+
## Feature requests
70+
71+
Feature requests are welcome. But take a moment to find out whether your idea
72+
fits with the scope and aims of the project. It's up to *you* to make a strong
73+
case to convince the project's developers of the merits of this feature. Please
74+
provide as much detail and context as possible.
75+
76+
77+
<a name="pull-requests"></a>
78+
## Pull requests
79+
80+
Good pull requests - patches, improvements, new features - are a fantastic
81+
help. They should remain focused in scope and avoid containing unrelated
82+
commits.
83+
84+
**Please ask first** before embarking on any significant pull request (e.g.
85+
implementing features, refactoring code, porting to a different language),
86+
otherwise you risk spending a lot of time working on something that the
87+
project's developers might not want to merge into the project.
88+
89+
Please adhere to the coding conventions used throughout a project (indentation,
90+
accurate comments, etc.) and any other requirements (such as test coverage).
91+
92+
Follow this process if you'd like your work considered for inclusion in the
93+
project:
94+
95+
1. [Fork](http://help.github.com/fork-a-repo/) the project, clone your fork,
96+
and configure the remotes:
97+
98+
```bash
99+
# Clone your fork of the repo into the current directory
100+
git clone https://github.com/<your-username>/<repo-name>
101+
# Navigate to the newly cloned directory
102+
cd <repo-name>
103+
# Assign the original repo to a remote called "upstream"
104+
git remote add upstream https://github.com/<upstream-owner>/<repo-name>
105+
```
106+
107+
2. If you cloned a while ago, get the latest changes from upstream:
108+
109+
```bash
110+
git checkout <dev-branch>
111+
git pull upstream <dev-branch>
112+
```
113+
114+
3. Create a new topic branch (off the main project development branch) to
115+
contain your feature, change, or fix:
116+
117+
```bash
118+
git checkout -b <topic-branch-name>
119+
```
120+
121+
4. Commit your changes in logical chunks. Please adhere to these [git commit
122+
message guidelines](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)
123+
or your code is unlikely be merged into the main project. Use Git's
124+
[interactive rebase](https://help.github.com/articles/interactive-rebase)
125+
feature to tidy up your commits before making them public.
126+
127+
5. Locally merge (or rebase) the upstream development branch into your topic branch:
128+
129+
```bash
130+
git pull [--rebase] upstream <dev-branch>
131+
```
132+
133+
6. Push your topic branch up to your fork:
134+
135+
```bash
136+
git push origin <topic-branch-name>
137+
```
138+
139+
7. [Open a Pull Request](https://help.github.com/articles/using-pull-requests/)
140+
with a clear title and description.
141+
142+
### Checklist before making a pull request
143+
- Make sure your code does not have nay linting errors.
144+
- Make sure you have written proper test cases for every piece of code you have added. Every line and branch should be covered.
145+
- Execute the command `npm run ci` before making a pull request and fix any errors if you see.
146+
147+
**IMPORTANT**: By submitting a patch, you agree to allow the project owner to
148+
license your work under the same license as that used by the project.
149+
150+
And last but not least: Always write your commit messages in the present tense. Your commit message should describe what the commit, when applied, does to the code – not what you did to the code.
151+
152+
Your contributions are welcome!

0 commit comments

Comments
 (0)
Please sign in to comment.