First off, thank you for considering contributing to Holder. It's people like you that make Holder such a great tool.
This project and everyone participating in it is governed by the Holder Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].
(Describe here the basic architecture of your project, where the main parts are, etc.)
This section guides you through submitting a bug report for Holder. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports.
Before submitting a bug report
- Check the FAQs on the forum for a list of common questions and problems.
- Perform a cursory search to see if the problem has already been reported. If it has and the issue is still open, add a comment to the existing issue instead of opening a new one.
How Do I Submit A (Good) Bug Report? Bugs are tracked as GitHub issues. Explain the problem and include additional details to help maintainers reproduce the problem:
- Use a clear and descriptive title for the issue to identify the problem.
- Describe the exact steps which reproduce the problem in as many details as possible. When listing steps, don't just say what you did, but explain how you did it.
- Provide specific examples to demonstrate the steps. Include links to files or GitHub projects, or copy/pasteable snippets, which you use in those examples.
- Describe the behavior you observed after following the steps and point out what exactly is the problem with that behavior.
- Explain which behavior you expected to see instead and why.
- Include screenshots and animated GIFs which show you following the described steps and clearly demonstrate the problem.
This section guides you through submitting an enhancement suggestion for Holder, including completely new features and minor improvements to existing functionality.
Before submitting an enhancement suggestion
- Check the issue tracker to see if the enhancement has already been suggested.
- Perform a cursory search to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
The process described here has several goals:
- Maintain Holder's quality
- Fix problems that are important to users
- Engage the community in working toward the best possible Holder
- Enable a sustainable system for Holder's maintainers to review contributions