Skip to content

CONTRIBUTING.rst

Latest commit

 

History

History
25 lines (20 loc) · 1.56 KB

CONTRIBUTING.rst

File metadata and controls

25 lines (20 loc) · 1.56 KB

Contributing to Pan3D

  1. Clone the repository using git clone
  2. Install pre-commit via pip install pre-commit
  3. Run pre-commit install to set up pre-commit hooks
  4. Make changes to the code, and commit your changes to a separate branch
  5. Create a fork of the repository on GitHub
  6. Push your branch to your fork, and open a pull request

Tips

  1. When first creating a new project, it is helpful to run pre-commit run --all-files to ensure all files pass the pre-commit checks.
  2. A quick way to fix ruff issues is by installing black (pip install ruff) and running the ruff format and ruff check command at the root of your repository.
  3. A quick way to fix codespell issues is by installing codespell (pip install codespell) and running the codespell -w command at the root of your directory.
  4. The .codespellrc file can be used fix any other codespell issues, such as ignoring certain files, directories, words, or regular expressions.

Release process and commit messages

Releases are automatically produced based on the commits that are merged into master. We rely on semantic-release to tag releases and produce CHANGELOG.md. To support that automated process, you need to follow that convention on your commit messages.