CONTRIBUTING.md

Contributing

We appreciate your interest in contributing. To ensure a smooth collaboration, please review the following guidelines.

How to Contribute

1. Get the latest version of the repository:
   • For the first time: Fork the repository. Clone the forked repository to your local machine.
   • For the second time: Sync your fork with the main repository.
2. Create a new branch for your changes:

   git checkout -b feature/new-feature

3. Make your changes and commit them:

   git commit -m "Add a concise commit message"

4. Push your changes to your fork:

   git push origin feature/new-feature

5. Open a pull request to the main repository on the main branch.

Code Style

• Use isort to reorder import statements
• Use yapf to format Python codes into Google style
• We use based_on_style = "google". See https://google.github.io/styleguide/pyguide.html
• Use Google Docstring Format to standardize docstrings
• Use Conventional Commits to make commit messages more readable