Skip to content

Commit 1bc10a4

Browse files
Create CONTRIBUTING.md
1 parent 8d5f00c commit 1bc10a4

File tree

1 file changed

+40
-0
lines changed

1 file changed

+40
-0
lines changed

Diff for: CONTRIBUTING.md

+40
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# Contributing
2+
3+
If you have found an issue or would like to request a new feature, simply create a new issue detailing the request. We also welcome pull requests. See below for information on getting started with development and submitting pull requests.
4+
5+
## Found an Issue?
6+
If you find a bug in the source code or a mistake in the documentation, you can help us by
7+
submitting an issue to our [GitHub Repository](https://github.com/reactstrap/reactstrap/issues/new). Even better you can submit a Pull Request
8+
with a fix.
9+
10+
**Please see the Submission Guidelines below**.
11+
12+
## Want a Feature?
13+
14+
You can request a new feature by submitting an issue to our [GitHub Repository](https://github.com/reactstrap/reactstrap/issues/new). If you
15+
would like to implement a new feature then consider what kind of change it is:
16+
17+
* **Major Changes** that you wish to contribute to the project should be discussed first in a [GitHub Issue](https://github.com/reactstrap/reactstrap/issues/new) or [Slack](https://reactstrap.slack.com) so that we can better coordinate our efforts, prevent
18+
duplication of work, and help you to craft the change so that it is successfully accepted into the
19+
project. Slack invites can be obtained [here](https://reactstrap.herokuapp.com/).
20+
* **Small Changes** can be crafted and submitted to the [GitHub Repository](https://github.com/reactstrap/reactstrap) as a Pull Request.
21+
22+
### Submitting a Pull Request
23+
24+
If you wish to submit a pull request for a new feature or issue, you should start by forking this repository first. After you have forked and cloned the repository locally, create a new branch with a name that loosely describes the issue on which you will be working. Once you think you have the addressed the issue in question, submit a pull request. Here are some guidelines to follow when writing code for reactstrap:
25+
26+
- Commit messages should follow Angular's [Git Commit Guidelines](https://github.com/angular/angular.js/blob/master/CONTRIBUTING.md#-git-commit-guidelines).
27+
- Intermediate and work-in-progress commits should be rebased out.
28+
- Keep pull requests tightly scoped to the issue or feature being addressed.
29+
- All changes from every developer must go through code review before they will be merged.
30+
- All changes must pass the CI build. Travis CI will automatically update your PR with the build status.
31+
- All changes must have unit tests.
32+
- All components must have a demo implementation in the `docs/lib/examples` directory.
33+
34+
## Resources
35+
36+
- [StackBlitz](https://stackblitz.com/edit/reactstrap?file=Example.js)
37+
- [Slack](https://reactstrap.slack.com)
38+
- [Get Slack Invite](https://reactstrap.herokuapp.com/)
39+
- [Ask Stackoverflow](http://stackoverflow.com/questions/ask?tags=reactstrap+react)
40+
- [View Stackoverflow reactstrap tag](http://stackoverflow.com/questions/tagged/reactstrap)

0 commit comments

Comments
 (0)