Skip to content

Latest commit

 

History

History
71 lines (46 loc) · 3.06 KB

CONTRIBUTING.md

File metadata and controls

71 lines (46 loc) · 3.06 KB
Raw

Contributing to cli-surf

Thank you for your interest in contributing to cli-surf! All contributions are welcome, from commenting issues to reviewing or sending Pull Requests.

Join the Discord!

How to contribute?

If you are new to GitHub, visit the first-contributions instructions to learn how to contribute on GitHub.

To find issues you can help with, go though the list of good first issues or issues labeled with help wanted.

Once you find an interesting issue let us know that you want to work on it by commenting on the issue.

Development

Install our development environment

Please set up your development environment by referring to the Setup section in the README.md.

Warning

Make sure to run make install to ensure that lint and format are executed reliably when using the git commit command.

Code Style and Quality

  • The PEP 8 styling convention is used.
  • This is achieved using the ruff Linter and Formatter.
  • The Linter and Formatter are automatically executed before committing via pre-commit.
    • If you want to run the Linter and Formatter at any time, execute pre-commit run --all-files. Or, make format and make run can be ran.

Testing

Note

This project uses Makefile as a task runner. You need to set up your environment to be able to run the make command.

Run the following command in the project's root directory:

# Run tests locally using Poetry
make test

# Run tests Docker container
make test_docker

You can generate a coverage report with the following command:

# Generate a coverage report locally using Poetry
make output_coverage

# Generate a coverage report in a Docker container
make output_coverage_docker

Additionally, when a PR is raised, pytest will be executed by the GitHub Actions CI.

Adding yourself to the contributors list

On your issue/PR, simply ask the @all-contributors bot to add yourself!

@all-contributors please add @<username> for <contributions>

See documentation here

Questions, suggestions or new ideas

Please don't open an issue to ask a question or suggestion. Instead, use the GitHub Discussions page. New ideas and enhacements are also welcome as discussion posts.

Issue reporting

Feel free to create a new issue if you have an issue to report! But first, make sure that the issue has not been reported yet.

Be sure to explain in details the context and the outcome that you are lookign for. If reporting bugs, provide basic information like your OS version, whether using Docker, etc.

Thanks! 🌊 🏄