Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
149 lines (94 loc) · 3.8 KB

CONTRIBUTING.md

File metadata and controls

149 lines (94 loc) · 3.8 KB

Contributing

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/Feverup/aiocop/issues.

If you are reporting a bug, please include:

  • Your operating system name and version.
  • Your Python 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 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

aiocop 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/Feverup/aiocop/issues.

If you are proposing a 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 aiocop for local development.

  1. Fork the aiocop repo on GitHub.

  2. Clone your fork locally:

    git clone git@github.com:your_name_here/aiocop.git
cd aiocop

  3. Install uv if you haven't already:

    curl -LsSf https://astral.sh/uv/install.sh | sh

  4. Install the project with development dependencies:

    uv sync --extra test

  5. Create a branch for local development:

    git checkout -b name-of-your-bugfix-or-feature

    Now you can make your changes locally.

  6. When you're done making changes, check that your changes pass linting and tests:

    # Run linter
uv run ruff check

# Run tests
uv run pytest

  7. 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

  8. 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.
  3. The pull request should work for Python 3.10, 3.11, 3.12, and 3.13. Tests run in GitHub Actions on every pull request to the main branch, make sure that the tests pass for all supported Python versions.

Tips

To run a subset of tests:

uv run pytest tests/test_aiocop.py -k "test_name"

To run tests with coverage:

uv run coverage run -m pytest
uv run coverage report

Deploying

A reminder for the maintainers on how to deploy:

  1. Make sure all your changes are committed (including an entry in HISTORY.md).

  2. Update the version in pyproject.toml:

    version = "0.2.0"

  3. Commit the version bump:

    git add pyproject.toml HISTORY.md
git commit -m "Bump version to 0.2.0"
git push

  4. Create and push a tag:

    git tag v0.2.0
git push origin v0.2.0

The GitHub Actions workflow will automatically build and publish the package to PyPI when a new tag is pushed.

Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.