😄 First of all, thanks for taking the time to contribute! 😄
The following is a set of guidelines for contributing to Pansy. Before start doing anything, ask if that change is useful, otherwise you may be spending time and then not getting your PR merged. You can always use the issues or the discord server.
You can find the Pansy Code of Conduct right here. Please make sure to be respectful and kind at all times!
This section guides you through submitting a bug report for Pansy. Following these guidelines helps maintainers and the community understand your report 📝, reproduce the behaviour and find related reports 🔎.
Before creating bug reports, please check the issues list as you might find out that you don't need to create one. When you are creating a bug report, please include as many details as possible. Fill out the required templated, the information it asks for helps us resolve issues faster.
Note: If you find a Closed issue that seems like it is the same thing that you are experiencing, open a new issue and include a link to the original issue in the body of the new one.
Plase make sure that you have the latest version. The issue you are experiencing may have been reported before and been fixed on newer versions.
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. For example, start by explaining how you started Pansy, e.g. which command exactly you used in the terminal, or how you started Pansy otherwise. 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. If you're providing snippets in the issue, use Markdown code blocks.
- 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.
- If you're reporting that Atom crashed, include a crash report with a stack trace.
This section guides you through submitting an enhancement suggestion for Pansy, including completely new features and minor improvements to existing functionality. Following these guidelines helps maintainers and the community understand your suggestion 📝 and find related suggestions 🔎.
Before creating bug reports, please check the issues list as you might find out that you don't need to create one. When you are creating an enhancement suggestion, please include as many details as possible. Fill out the required templated, including the steps that you imagine you would take if the feature you're requesting existed.
Unsure where to begin contributing to Pansy? You can start by looking through these good-first-issue and help-wanted issues.
The process described here has several goals:
- Maintain Pansy's quality
- Fix problems that are important to users
Please follow all instructions in the template to have your contribution considered by the maintainers.