Skip to content

Commit 2252f6f

Browse files
eddywashereeddywashere
authored
docs(Contributing): update docs with helpful content
* docs(Contributing): update docs with helpful content * build(travis): only build prs and commits to master http://stackoverflow.com/questions/31882306/how-to-configure-travis-ci-t o-build-pull-requests-merges-to-master-w-o-redunda
1 parent 45b285b commit 2252f6f

4 files changed

Lines changed: 57 additions & 2 deletions

File tree

‎.travis.yml‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,3 +19,6 @@ after_success:
1919
env:
2020
global:
2121
secure: GKu1vrkY7RWrrp0VOyxBjGSyTOGdU9jNT+oYR7P12PbCX4yzZ2mbsPpxWWs7Uh8ZXm5VEEfkrF80v/ccUEMvf1MD/q95nqLcQRoN/31yDhiJ66uW+mZk0C6OqUUZJlcSt1Ta6oLmLVmkJUu2euOo4ZTGQ1iwV9EOS+auPYUjXF7df8JE9sTof4YM3jUiQ+3ABIG8cOcsf81AyS9TOcpH6xPEs71Hz0uXta3TAAYpLgJSuuCciQn5Sr/9UIh9w10zAasSZBy27+A5mTf0C0xk3vN95cHfyS25r5x/zC3++YS//6MQASruT05Hf7STpF9Dy/6mdg6tMfGr+85zDqpMaF1dP5Rm9f8KHqZzYD52PtwLEkHpWwi/gqHY5vc+wHla5FEXiqawtBTRMj/hlvkvdN55qZnnFmsVEPrhHAIm1a8ECngzkZhG9QblszGgc55RtAtgGSlVsS5VWStsj29xLs2VJb6gYj69cMDSIND4e5VYzmrnaO/qRbzvRWJUIWFo/nmpSnAQbq5yV8K1+VukbxX/hF7+mE55ieeVww8tnC2bkxuQF1CbzTul5kPgAD7Hf8YdsSczvdZpSRHtN6OXGCotw4DRAiXZRb5TLFvEQFvbrNGciN5/Z1rXxlMr8WWwckAFxVW1EQd+kKg8abjCOLE+YY04a+h3W/+XOgDPUlA=
22+
branches:
23+
only:
24+
- master

‎CONTRIBUTING.md‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
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+
- [Codepen Demo](http://codepen.io/eddywashere/pen/ZOjmkm)
37+
- [Slack](https://reactstrap.slack.com)
38+
- [Slack Invite](https://reactstrap.herokuapp.com/)
39+
- [stackoverflow](stackoverflow.com/questions/ask?tags=reactstrap+react)

‎ISSUE_TEMPLATE.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
<!-- The following is part of our issue template, feel free to remove this if it doesn't apply -->
2+
### Issue description
3+
4+
- version `#x.x.x`
5+
- components: `name`
6+
7+
### Steps to reproduce issue
8+
9+
- ...
10+
11+
<!-- The following codepen can be forked to help demonstrate the issue http://codepen.io/eddywashere/pen/ZOjmkm -->

‎README.md‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Easy to use React Bootstrap 4 components compatible with React 0.14.x and 15.x.
99

1010
## Installation
1111

12-
Install `reactstrap` and peer dependencies via NPM
12+
Install `reactstrap` and __peer dependencies__ via NPM
1313

1414
```sh
1515
npm install --save reactstrap react-addons-transition-group react react-dom
@@ -73,7 +73,7 @@ This library contains the following components:
7373
- [ButtonGroup](https://reactstrap.github.io/components/button-group/)
7474
- [ButtonToolbar](https://reactstrap.github.io/components/button-group/)
7575
- [Dropdown](https://reactstrap.github.io/components/dropdowns/)
76-
- [Labels](https://reactstrap.github.io/components/labels/)
76+
- [Tags](https://reactstrap.github.io/components/tags/)
7777
- [Card](https://reactstrap.github.io/components/card/)
7878
- [Popover](https://reactstrap.github.io/components/popovers/)
7979
- [Modal](https://reactstrap.github.io/components/modals/)
@@ -84,6 +84,8 @@ This library contains the following components:
8484
- [Layout](https://reactstrap.github.io/components/layout/)
8585
- [Tables](https://reactstrap.github.io/components/tables/)
8686

87+
## [Contributing](CONTRIBUTING.md)
88+
8789
## Development
8890

8991
Install dependencies:

0 commit comments

Comments
 (0)