Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
123 lines (79 loc) · 3.31 KB

CONTRIBUTING.md

File metadata and controls

123 lines (79 loc) · 3.31 KB

Contributing to iscc-search

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

You can contribute in many ways:

Types of Contributions

Report Bugs

Report bugs at https://github.com/iscc/iscc-search/issues

If you are reporting a bug, please include:

  • Your operating system name and version.
  • Any details about your local setup that might be helpful in troubleshooting.
  • Detailed steps to reproduce the bug.

Fix Bugs

Look through the GitHub issues for bugs. Anything tagged with "bug" and "help wanted" is open to whoever wants to implement a fix for it.

Implement Features

Look through the GitHub issues for features. Anything tagged with "enhancement" and "help wanted" is open to whoever wants to implement it.

Write Documentation

iscc-search could always use more documentation, whether as part of the official docs, in docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback

The best way to send feedback is to file an issue at https://github.com/iscc/iscc-search/issues.

If you are proposing a new feature:

  • Explain in detail how it would work.
  • Keep the scope as narrow as possible, to make it easier to implement.
  • Remember that this is a volunteer-driven project, and that contributions are welcome :)

Get Started!

Ready to contribute? Here's how to set up iscc-search for local development. Please note this documentation assumes you already have uv and Git installed and ready to go.

  1. Fork the iscc-search repo on GitHub.

  2. Clone your fork locally:

cd <directory_in_which_repo_should_be_created>
git clone [email protected]:YOUR_NAME/iscc-search.git
  1. Now we need to install the environment. Navigate into the directory
cd iscc-search

Then, install and activate the environment with:

uv run poe install
  1. Install pre-commit to run linters/formatters at commit time:
uv run pre-commit install
  1. Create a branch for local development:
git checkout -b name-of-your-bugfix-or-feature

Now you can make your changes locally.

  1. Don't forget to add test cases for your added functionality to the tests directory.

  2. When you're done making changes, run all pre-commit tasks:

uv run poe all

This single command will format your code, run all checks, execute tests, and validate documentation. Alternatively, you can run individual tasks:

uv run poe format    # Format code and markdown
uv run poe check     # Run linting and type checking
uv run poe test      # Run unit tests
uv run poe docs-test # Test documentation build

  1. Before raising a pull request, ensure all tests pass. The CI/CD pipeline will test across different Python versions automatically.

  2. Commit your changes and push your branch to GitHub:

git add .
git commit -m "Your detailed description of your changes."
git push origin name-of-your-bugfix-or-feature
  1. Submit a pull request through the GitHub website.

Pull Request Guidelines

Before you submit a pull request, check that it meets these guidelines:

  1. The pull request should include tests.

  2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.md.