First thanks for take time to contribute and read this document! 👍✨
This document sets up some basic guidelines for contributing to resi-script-manager Most of this are guidelines but no rules. Use your best judgement when you open issues and pull requests. Also feel free to propose changes on this document in a pull request or issue.
The project and everyone in it is governed by the Code of conduct. By participating, you are expected to uphold this. Please report unacceptable behavior to [email protected].
Note: Please don´t open an issue for questions.
For questions please use the Discussions tab.
This should help you to report a bug for resi-script-manager. Following this guide could help contributors to understand, reproduce and fix your bug.
We use GitHub issues for bug tracking and documentation of problems.
Before you create a bug report, please check this list and maybe you don´t need to create a bug report. Please include as many details as possible. Please use the issue template for bug reports.
-
Please check your installed version of the script. When it is not the newest version please update the script and check if your bug is fixed.
-
Perform a cursory search to see if your problem has already been reported. If it has and the issue is open add a comment instead opening a new one.
Note: If you find a closed issue that describes the same problem as you, open a new issue and link the original issue at the end of your text.
Provide the following information by filling out the template.
Explain the problem and include additional details to help contributors reproduce your problem
- Use a clear and despriptive title for your issue.
- Provide the exact steps which reproduce the problem.
- Describe the observed behavior and point out what exactly is the problem with that behavior.
- Explain your expected behavior.
This should help you to suggest enhancements for resi-script-manager. Following this guide could help contributors to understand and implement your feature.
We use GitHub issues for getting enhancement input.
Before you create an enhancement suggestion, please check this list and maybe you don´t need to create one. Please include as many details as possible. Please use the issue template for enhancement suggsetions.
-
Please check your installed version of the script. When it is not the newest version please update the script and check if your feature idea is included.
-
Perform a cursory search to see if your enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
- Use a clear and despriptive title for your issue.
- Provide a step-by-step description of the suggested enhancement in as many steps as possible.
- Explain why this enhancement would be useful.
When you are unshure where you should start? You can start with beginner or help wanted issues:
-
Follow instructions in the template.
-
Follow the styleguides.
-
When you opened a pull request for an issue, open the pull request to the branch the milestone label is set on the issue.
3.1. When your pull request isn´t for an issue or the issue has no milestone label, open the pull request to the branch for the next version.
-
After submitting your pull request, verifiy that all status checks are passing
What if the status checks are failing
If a status check fails and you believe that this is a mistake, please leave a comment on the pull request explaining why you believe the failure is a mistake. A maintainer will re-run the status checks for you. When the status check fails again you must check your contribution.-
Use past participle ("Added feature" not "Add feature")
-
Consider starting the commit message with an applicable emoji:
-
⬇️
:arrow_down:when downgrading dependencies -
⬆️
:arrow_up:when upgrading dependencies -
🎨
:art:when improving the format/structure of the code -
📚
:books:when writing documentation -
🐛
:bug:when fixing a bug -
🔥
:fire:when removing code or files -
🔒
:lock:when dealing with security -
🐎
:racehorse:when improving performance -
✨
:sparkles:when adding new feature
-
For a full list take a look at gitmoji.dev.
| Label name | search 🔎 | Description |
|---|---|---|
| beginner | search | Good for newcomers |
| bug | search | Something doesn´t work |
| duplicate | search | This issue or pull request already exists |
| enhancement | search | New feature request |
| feedback | search | Generall feedback |
| help wanted | search | Extra attention is needed |
| invalid | search | That doesn´t seem right |
| needs reproduction | search | Bugs that need hints for reproduction |
| question | search | Further information is requested |
| wontfix | search | This will not be worked on |
| Label name | search 🔎 | Description |
|---|---|---|
| documentation | search | Improvements or additions to documentation |
| security | search | Security problems |
I got my inspiration for this file from the Atom CONTRIBUTING.md file. Thank you! 💚