Contributing to Gymkhana

We want to make contributing to this project as easy and transparent as possible, whether it's:

Standard Commit Messages

This project is using the conventional commits standard. Please follow these steps to ensure your commit messages are standardized:

Commit messages should have this format: <type>[optional scope]: <description>
Type must be one of the following:
- build: Changes that affect the build system or external dependencies
- ci: Changes to our CI configuration files and scripts
- docs: Documentation only changes
- feat: A new feature
- fix: A bug fix
- perf: A code change that improves performance
- chore: A code change that neither fixes a bug nor adds a feature
- refactor: A code change that improves code quality or makes it easier to maintain
- style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
- test: Adding missing tests or correcting existing tests
Scope should be ui or api or global.
Description should be concise and in present imperative tense as mentioned here.
Example: feat(ui): add dark-mode

Run git fetch upstream & git rebase upstream/master to fetch updated codebase into your local repository before creating any new branch.
Run git checkout -b <your-branch-name>.
Request to get an issue assigned. (Comment on the issue.)
Work on the issue.
Make sure all tests are passing before making pull request.
Make sure the code is properly formatted and follows style guidelines.
- Run flake8 path/to/code/to/check.py or flake8 path/to/code/ to check for lint errors in api.