Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #113 from Tjoosten/patch-1
Add contribution file.
- Loading branch information
Showing
1 changed file
with
58 additions
and
0 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 |
---|---|---|
@@ -0,0 +1,58 @@ | ||
Contributing to irail/irail | ||
=============================== | ||
|
||
Looking to contribute something to irail/irail? **Here's how you can help.** | ||
|
||
Please take a moment to review this document in order to make the contribution | ||
process easy and effective for everyone involved. | ||
|
||
Following these guidelines helps to communicate that you respect the time of the developers managing and developing | ||
this open source project. In return, they should reciprocate that respect in addressing your issue or assessing patches | ||
and features. | ||
|
||
### Using the issue tracker | ||
|
||
The [issue tracker](https://github.com/irail/irail/issues) is preffered channel for bug reports, features requests and submitting pull requests, | ||
but please respect the following restrictions: | ||
|
||
- Please **do not** use the issue tracker for personal support requests. | ||
Our [gitter channel](https://gitter.im/iRail/iRail) is a better place to get help. | ||
- Please **do not** derail or troll issues. Keep the discussion on topic and respect the opinions of others. | ||
|
||
### Issues and labels | ||
|
||
Our bug tracker utilizes several labels to help organize and identify issues. | ||
Here's what they represent and how we use them. | ||
|
||
- `confirmed` - Issues that have been comfirmed with a reduced test case and identify a bug in irail/irail. | ||
- `feature` - Issues asking for a new feature to be added. | ||
- `wontfix` - Issues that will not fixed this time. It doesn't mean that we don't ever fix that issue. | ||
- `duplicate` - Issues that duplicate another issue. | ||
|
||
For a complete look at our labels, see the [project labels page](https://github.com/irail/irail/labels). | ||
|
||
### Bug reports | ||
|
||
A bug is a *demonstrable problem* that is caused by the code in the code in the repository. Good bug reports are extremely helpful, | ||
so thanks! | ||
|
||
Guidelines for bug reports: | ||
|
||
1. **Validate and lint your code.** | ||
2. **Use the GitHub issue search** - Check if the issue has already been reported. | ||
3. **Check if the issue has been fixed** - try to reproduce the issue using the latest `master` branch in the repository. | ||
4. **Isolate the issue** | ||
|
||
A good bug report shouldn't leave others needing to chase you up for more information. | ||
Please try to be as detailed as possible in your report. What is your environment? What steps will reproduce the issue? | ||
What browser(s) and OS experience the problem? Do other browsers show the bug differently? What would you expect to be the outcome? | ||
All these details will help people to fix any potential bugs. | ||
|
||
### Pull requests. | ||
|
||
A pull request against this repo has the following things: | ||
|
||
- **PSR-2 coding standard.** | ||
- **Must pass StyleCI and TravisCI.** | ||
- **A good description of what u have changed and/or added** | ||
- **A specific PR title. No general title like: Improvements** |