👍🎉 First off, thanks for taking the time to contribute! 🎉👍
The following is a set of guidelines for contributing to Volder, which are hosted in the Dev Supporters Community on GitHub. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes in a pull request.
This section guides you through submitting a bug report for Volder. Following these guidelines helps maintainers and the community understand your report 📝, reproduce the behavior 💻, and find related reports 🔎.
When you find a bug create an issue. If you are a beginner check out How to create an issue. When you are creating a bug report, please [include as many details as possible]
Note: If you find a Closed issue that seems like it is the same thing that you're experiencing, open a new issue and include a link to the original issue in the body of your new one.
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.
- 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.You can also checkout Markdown Cheatsheet.
- 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.
This section guides you through submitting an enhancement suggestion for Volder, including completely new features and minor improvements to existing functionality.
Enhancement suggestions are tracked as GitHub issues.If you are a beginner check out How to create an issue.
- Use a clear and descriptive title for the issue to identify the suggestion.
- Provide a step-by-step description of the suggested enhancement in as many details as possible.
- Provide specific examples to demonstrate the steps. Include copy/pasteable snippets which you use in those examples, as Markdown code blocks.
- Include screenshots and animated GIFs which help you demonstrate the steps or point out the part of Volder which the suggestion is related to. You can use this tool to record GIFs on macOS and Windows, and this tool or this tool on Linux.
- Explain why this enhancement would be useful to most Volder users.
Unsure where to begin contributing to Volder? You can start by looking through these documentation, help-wanted, enhancement, and good first issue issues:
Checkout the comments of these issues, If you feel like contributing, comment on that perticular issue to assign that issue to you.
The process described here has several goals:
- Maintain Volder's quality
- Fix problems that are important to users
- Engage the community in working toward the best possible Volder
If you are a beginner and don't know how to make a pull request, check out this guide.
- 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
- When only changing documentation, include
[ci skip]in the commit title - Consider starting the commit message with an applicable emoji:
- 🎨
:art:when improving the format/structure of the code - 🐎
:performance:when improving performance - 🚱
:non-potable_water:when plugging memory leaks - 📝
:documentation:when writing docs - 🐛
:bug:when fixing a bug - 🔥
:fire:when removing code or files - 💚
:CI improvment:when fixing or improve the CI build - ✅
:test:when adding tests - 🔒
:lock:when dealing with security
- 🎨
Use Markdown to write documentation.
Keep contributing 👨💻