-
Notifications
You must be signed in to change notification settings - Fork 0
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
Showing
1 changed file
with
37 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,37 @@ | ||
# How to contribute to this repo | ||
|
||
We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's: | ||
|
||
- Reporting a bug | ||
- Proposing new features | ||
- Discussing the current state of the code | ||
- Submitting a fix | ||
|
||
This is how you should do it: | ||
|
||
Use our [issue list](../../issues) to report a **bug** or **propose a new feature**, including | ||
|
||
### For **bug report** | ||
- A quick summary and/or background | ||
- Steps to reproduce | ||
- Be specific! | ||
- Give sample code if you can | ||
- What you expected would happen | ||
- What actually happens | ||
|
||
The team love thorough bug reports - no it's not a joke! | ||
|
||
### For **feature request** | ||
- Brief description of the feature | ||
- What problem/issue will this solve | ||
- A sort of Definition of Done - "How should it look when finsihed" | ||
|
||
### When submitting a fix using a Pull Request (PR) | ||
|
||
- Fork this repository from GitHub | ||
- Once, you have a local copy (after forking) you can make edits to the code, make formatting changes, reorganise the code, add documentation etc … | ||
- After you have made the changes, you have to create a pull request | ||
|
||
We will review the pull request and if it appropriate and there are no clashes or vulnerabilities, it will be merged to the main code | ||
|
||
Voila! you have contributed to a piece of software and the cycle repeats. |