Thanks for willing to contribute in making Eruditus a better bot!
You can contribute in different ways, for example, you could:
- Fix a bug
- Fix a typo
- Refactor some code
- Implement a new feature
- Suggest a new feature
- Fork this repository
- Clone the forked repository
git clone https://github.com/${your_username}/Eruditus - Make a separate branch
git checkout -b develop - Make changes locally
- Stage the affected files
git add <files> - Commit your changes
git commit -m "short description of your changes" - Push your changes
git push origin develop - Make a Pull Request.
We're trying to stick to the PEP 8 standards most of the time, though we don't respect their 79 characters per line recommendation and use 88 instead.
PEP 484 type annotations are being used, and for documentation strings (docstrings), we try to use Google docstrings when possible.
After writing your code, please consider running black on it:
$ black .
As a second pass, consider running flake8 using the following command:
$ flake8 . --ignore=W503 --max-line-length=88 --show-source
Once flake8 stops reporting warnings, you should be good to go.
Install these tools using: python3 -m pip install black flake8