Contributing

Thanks for your interest in contributing to tinydantic!

If you want to see how this project compares to recommended community standards, you can check out the tinydantic Community Standards page.

Code of Conduct

This project and everyone participating in it is governed by the tinydantic Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior directly on GitHub so that the issue can be managed and resolved on the platform. Please also feel free to reach out directly at christopher.david.wilson@gmail.com.

I have a question

If you have a question about how to use tinydantic, first check out the documentation.

If you still need help, feel free to start a discussion!

I found a bug

We use GitHub issues to track bugs and other issues. If you run into an issue with the project, start by searching for existing Issues and Discussions to see if the bug has already been reported by someone else.

If the issue has not already been reported, open a new issue.

Important

If you think you have identified a security issue with a tinydantic project, do not open a public issue!

See the Security Policy for instructions on how to responsibly report your findings.

I want to contribute

You can contribute to tinydantic by submitting a pull request to:

1. Fix a bug
2. Add a new feature
3. Improve the documentation

Important

When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content, and that the content you contribute may be provided under the project license.

If you are new to the project, check out https://github.com/tinydantic/tinydantic/contribute for a list of good first issues.

Tip

Before submitting a larger pull request (e.g. new features or breaking changes), consider creating an issue to outline your proposed changes.

The next section describes how to set up a development environment and create a pull request to submit your changes for review.