creyD/asiimov
1
0
Fork 0
mirror of https://github.com/creyD/asiimov.git synced 2026-06-12 00:52:23 +02:00
Code Packages Releases Activity

Added Contribution Guide

Browse Source
This commit is contained in:
Conrad
2020-01-02 20:29:40 +01:00
parent 7e467aebb9
commit 653fe645a0
1 changed files with 28 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
CONTRIBUTING.md Normal file
View File

@@ -0,0 +1,28 @@
# Contribution Guide
## Code Style
All Python code should be compatible with the latest Python version at the time. [Autopep8](https://pypi.org/project/autopep8/) will be automatically run against your code.
## What to contribute?
- Bug fixes (please look at the issues, if you can't find one for your bug --> create one)
- Security fixes (please don't discuss publicly for obvious reasons, consult one of the maintainers)
- Feature improvements (please create an issue for this with the according label and discuss openly)
- Spelling mistakes and new languages
- Code reworks (please discuss your steps in the pull request comments, i.e. why your code is better now)
## How to contribute?
In most cases the best thing you can do is to create an issue with your contribution and label it accordingly and wait for people to comment on it.
If you feel like the issue is easily fixable for you and the consensus of the issue is positive for your idea, go for it!
- Fork the repository
- Commit your changes with an understandable commit message
- Create a pull request from your fork to the main repository (preferably in the dev branch!)
- Profit!
## Which branch should I push to?
Please consult `README.md` for the branching model.