mirror of
https://gitlab.com/psuapp/psu.git
synced 2024-08-30 18:12:34 +00:00
29 lines
1.5 KiB
Markdown
29 lines
1.5 KiB
Markdown
# Contributing guidelines
|
|
|
|
Contributions are always welcome; however, please read this document in its entirety before submitting a pull request or reporting a bug.
|
|
|
|
## Creating an issue
|
|
|
|
To report a bug, propose a feature, etc. create an issue in the [issue tracker](https://github.com/greenled/portainer-stack-utils/issues). Your issue must follow these guidelines for it to be considered. Before submitting:
|
|
|
|
- Check you are on the latest version, the bug may have already been fixed!
|
|
- [Search the issue tracker](https://github.com/greenled/portainer-stack-utils/issues) for your problem, someone may have already reported it.
|
|
|
|
## Opening a pull request
|
|
|
|
To contribute, [fork](https://help.github.com/articles/fork-a-repo/)
|
|
`greenled/portainer-stack-utils`, commit your changes, and [open a pull
|
|
request](https://help.github.com/articles/using-pull-requests/).
|
|
|
|
Your pull request will be reviewed as soon as possible. You may be asked to make changes to your submission during the review process. Test your changes thoroughly before submitting.
|
|
|
|
If you are submitting a complex feature, bugfix, refactoring, etc. create a small design proposal in the [issue tracker](https://github.com/greenled/portainer-stack-utils/issues) before you start.
|
|
|
|
## Code of Conduct
|
|
|
|
All community members are expected to adhere to the project's [code of conduct](CODE_OF_CONDUCT.md).
|
|
|
|
## License
|
|
|
|
Source code contributed to this project will be licensed under the [GNU General Public License version 3](https://www.gnu.org/licenses/gpl-3.0.en.html). See [LICENSE](LICENSE) file for reference.
|