-
Notifications
You must be signed in to change notification settings - Fork 226
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
3dafbc3
commit 77c19bb
Showing
1 changed file
with
18 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,22 @@ | ||
Contributing Code to `fluxible-router` | ||
--------------------------------------------- | ||
|
||
Please be sure to sign our [CLA][] before you submit pull requests or otherwise contribute to `fluxible-router`. This protects developers, who rely on [BSD license][]. | ||
# How to contribute | ||
First, thanks for taking the time to contribute to our project! The following information provides a guide for making contributions. | ||
|
||
[BSD license]: https://github.com/yahoo/fluxible/blob/master/LICENSE.md | ||
[CLA]: https://yahoocla.herokuapp.com/ | ||
## Code of Conduct | ||
By participating in this project, you agree to abide by the [Yahoo, Inc. Code of Conduct](Code-of-Conduct.md). Everyone is welcome to submit a pull request or open an issue to improve the documentation, add improvements, or report bugs. | ||
|
||
## How to Ask a Question | ||
If you simply have a question that needs an answer, [create an issue](https://help.github.com/articles/creating-an-issue/), and label it as a question. | ||
|
||
### Report a Bug or Request a Feature | ||
If you encounter any bugs while using this software, or want to request a new feature or enhancement, feel free to [create an issue](https://help.github.com/articles/creating-an-issue/) to report it, make sure you add a label to indicate what type of issue it is. | ||
|
||
### Contribute Code | ||
Pull requests are welcome for bug fixes. If you want to implement something new, please [request a feature first](#report-a-bug-or-request-a-feature) so we can discuss it. | ||
|
||
#### Creating a Pull Request | ||
Please follow [best practices](https://github.com/trein/dev-best-practices/wiki/Git-Commit-Best-Practices) for creating git commits. | ||
|
||
When your code is ready to be submitted, you can [submit a pull request](https://help.github.com/articles/creating-a-pull-request/) to begin the code review process. |