Contributing to street-view-green-view

...Work in progress...

Development

This project uses Ruff for linting and automatic code formatting.

You can run linting with the following shell commands or use the make lint shortcut:

ruff format --check src
ruff check src

To format, run the following shell commands or make format:

ruff format src
ruff check src --fix

Please follow the Conventional Commits specification when creating your commit messages.

To check out a pull request branch from a fork, first install the GitHub CLI.

Then, from the repository, you can run, for example:

gh pr checkout 2

where the final number should be the PR number.

If you don't want to use the GitHub CLI, this can also be done using just regular git. See this StackOverflow answer.