-
Notifications
You must be signed in to change notification settings - Fork 268
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 #27 from intuitem/improve-contributing
Update CONTRIBUTING.md
- Loading branch information
Showing
1 changed file
with
15 additions
and
11 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,17 +1,21 @@ | ||
## How to contribute | ||
# How to contribute | ||
|
||
### Did you find a bug? | ||
## Did you find a bug? | ||
|
||
- **Do not open up a GitHub issue if the bug is a security vulnerability**, and instead to refer to our [security policy](SECURITY.md) | ||
- Check that the bug was not previously reported on Github issues (see above) | ||
- If it's case, please upvote the issue and provide any relevant additional information | ||
- **Do not open up a GitHub issue if the bug is a security vulnerability**, and instead to refer to our [security policy](SECURITY.md). | ||
- Check that the bug was not previously reported on Github issues (see above). | ||
- If it's the case, please upvote the issue and provide any relevant additional information. | ||
|
||
### Do you have a fix for an issue, bug or typo? | ||
## Do you have a fix for an issue, bug or typo? | ||
|
||
- Open a pull request with the patch and the team will review it | ||
- Make sure that you've run a PEP8 formatter and SAST | ||
- If dependencies are involved, make sure it's not breaking the app and do not have any known vulnerabilities | ||
- Open a pull request with the patch and the team will review it. | ||
- Make sure that you've run a PEP8 formatter and SAST. | ||
- If dependencies are involved, make sure it's not breaking the app and do not have any known vulnerabilities. | ||
|
||
### Do you have an idea or feature request? | ||
## Do you have an idea or feature request? | ||
|
||
- Use the discussion space above or reach out through email: contact[at]intuitem.com to see how we can help each other in an optimal way | ||
- Use the discussion space above or reach out through email: contact[at]intuitem.com to see how we can help each other in an optimal way. | ||
|
||
## Do you want to contribute to the code? | ||
|
||
- Please check our Contributor Licence Agreement first. Our bot will ask you to sign it on first contribution. |