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/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.
Fork the
cattrs
repo on GitHub.Clone your fork locally::
$ git clone git@github.com:your_name_here/cattrs.git
Install your local copy into a virtualenv. Assuming you have PDM installed, this is how you set up your fork for local development::
$ cd cattrs/
$ pdm install -d -G :all
Create a branch for local development::
$ git checkout -b name-of-your-bugfix-or-feature
Now you can make your changes locally.
When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox::
$ make lint
$ make test
$ tox
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
Submit a pull request through the GitHub website.
Pull Request Guidelines#
Before you submit a pull request, check that it meets these guidelines:
The pull request should include tests.
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.
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.
Don’t forget to add a line to HISTORY.md.
Tips#
To run a subset of tests:
$ pdm run pytest tests.test_unstructure