First off, thanks for taking the time to contribute! 🎉
The following is a set of guidelines for contributing to [Project Name], which is hosted in the GitHub Repository. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
This project and everyone participating in it is governed by the Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email@example.com].
This section guides you through submitting a bug report for [Project Name]. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports.
- Ensure the bug was not already reported by searching on GitHub under Issues.
- If you're unable to find an open issue addressing the problem, open a new one. Be sure to include:
- A descriptive title
- Detailed steps to reproduce the issue
- The expected behavior
- Screenshots or logs, if applicable
- The environment (e.g., OS, Node.js version)
This section guides you through submitting an enhancement suggestion for [Project Name], including completely new features and minor improvements to existing functionality.
- Ensure the enhancement was not already suggested by searching on GitHub under Issues.
- If you're unable to find an open issue addressing the suggestion, open a new one. Be sure to include:
- A descriptive title
- A detailed description of the enhancement
- Any relevant code, if applicable
The process described here will help you contribute to [Project Name]. This is a few steps to get started:
- Fork the repository and clone your fork.
- Create a new branch:
git checkout -b my-branch-name. - Make your changes and commit them:
git commit -m 'Add some feature'. - Push to the branch:
git push origin my-branch-name. - Submit a pull request.
If you have an improvement or a bug fix, open an issue first and discuss it with the maintainers.
- Use the present tense ("Add feature" not "Added feature")
- Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
- Limit the first line to 72 characters or less
- Reference issues and pull requests liberally after the first line
- Follow the coding style guide
- Ensure any install or build dependencies are removed before the end of the layer when doing a build.
- Update the documentation accordingly.
This section lists the labels we use to help us track and manage issues and pull requests. Here are some examples:
- bug - An issue that reports a bug
- enhancement - An issue that suggests an enhancement or new feature
- documentation - An issue that points out a documentation gap or error
Thank you for your contributions!