Welcome and thank you for considering contributing to Google Calendar Simple API open source project!
Before contributing to this repository, please first discuss the change you wish to make via Issue, GitHub Discussion, or Discord. Don’t hesitate to ask! Issue submissions, discussions, suggestions are as welcomed contributions as pull requests.
- Fork the repository
- Clone it with
git clone [email protected]:{your_username}/google-calendar-simple-api.git
- Install dependencies if needed with
pip install -e .
(orpip install -e ".[dev]"
if you want to run tests, compile documentation, etc.). Use virtualenv to avoid polluting your global python - Make and commit the changes. Add
closes #{issue_number}
to commit message if applies - Run the tests with
tox
(these will be run on pull request):tox
- all the teststox -e pytest
- unit teststox -e flake8
- style checktox -e sphinx
- docs compilation test
- Push
- Create pull request
- towards
dev
branch if the changes require a new GCSA version (i.e. changes in gcsa module) - towards
master
branch if they don't (e.x. changes in README, docs, tests)
- towards
- Follow the Code of conduct
- Follow the pep8 and the code style of the project (use your best judgement)
- Add documentation of your changes to code and/or to read-the-docs if needed (use your best judgement)
- Add tests if needed (use your best judgement)