Hello! Thank you for taking the time to learn how to make a contribution to one of my projects!
If you have not read it yet, please read the Code of Conduct. These guidelines ensure both maintainers and contributors work together in a respectful, inclusive way. Maintainers have a limited amount of time devoted to many projects, so we ask contributors to be considerate. In return, maintainers will reciprocate that respect and will consider, discuss, and support all acceptable contributions as appropriately identified in this document.
To give you an idea of which contributions are accepted or rejected, here are some examples of acceptable and unacceptable contributions.
Here are a few resources to learn more about contributing.
- https://makeapullrequest.com
- https://www.firsttimersonly.com
- https://app.egghead.io/playlists/how-to-contribute-to-an-open-source-project-on-github
- When you encounter an unexpected problem, open an Issue with a minimal, reproducible example.
- Comment on Issues, Discussions, or Pull Requests to provide constructive feedback or (functional) examples.
- Start a Discussion about a new feature idea.
- Write or record an unofficial tutorial about how to use or contribute to one of my projects.
- Submit a Pull Request that resolves an existing Issue.
- Submit a Pull Request that adds to the existing documentation.
- Please do not open an Issue for support questions. Use a Discussion instead.
- Please do not submit a Pull Request for an undocumented feature idea. All feature ideas should start as Discussions to ensure we have the chance to properly talk about and vet the ideas.
- Please do not submit a Pull Request purely for code quality (linting, refactoring, reorganizing, etc).
- Please do not comment on an Issue, Discussion, or Pull Request to engage in arguments or promote harassment. See our Code of Conduct.
- Please do not disclose security vulnerabilities in public. Send an email to hello@davidmyers.dev instead.