Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
124 lines (83 loc) · 3.59 KB

CONTRIBUTING.md

File metadata and controls

124 lines (83 loc) · 3.59 KB

Contributing

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

Important

If you use LLM / "AI" tools for your contributions, please read and follow our Generative AI / LLM Policy.

You can contribute in many ways:

Types of Contributions

Report Bugs

Report bugs at https://github.com/python-attrs/cattrs/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 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

cattrs could always use more documentation, whether as part of the official cattrs 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/python-attrs/cattrs/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 cattrs for local development.

  1. Fork the cattrs repo on GitHub.
  2. Clone your fork locally::
$ git clone git@github.com:your_name_here/cattrs.git
  1. Install your local copy into a virtualenv. Assuming you have uv installed, this is how you set up your fork for local development::
$ cd cattrs/
$ uv sync --all-groups --all-extras
  1. Create a branch for local development::
$ git switch -c name-of-your-bugfix-or-feature

Now you can make your changes locally.

  1. When you're done making changes, check that your changes pass lints and the tests, including testing other Python versions::
$ just lint
$ just test
$ just --set python python3.10 test  # Test on other versions
  1. Write any necessary documentation, including updating the changelog (HISTORY.md). The docs can be built like so:
$ just docs
$ just htmllive  # Build the docs, serve then and autoreload on changes
  1. 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. Only contribute code that you fully understand. See also our AI policy.
  2. The pull request should include tests.
  3. 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.rst.
  4. The pull request should work for all supported Python versions. Check https://github.com/python-attrs/cattrs/actions and make sure that the tests pass for all supported Python versions.
  5. Don't forget to add a line to HISTORY.md.

Tips

To run a subset of tests:

$ just test tests/test_unstructure.py