From 74ec8c1d22fc846d60569fda2ec5200f46ac9ba0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Juan=20Carlos=20Mej=C3=ADas=20Rodr=C3=ADguez?= Date: Mon, 22 Jul 2019 01:18:54 -0400 Subject: [PATCH] Add #Contributing section to readme --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index 9caa2ee..bf5f86d 100644 --- a/README.md +++ b/README.md @@ -199,6 +199,20 @@ In debug mode the script prints as much information as possible to help diagnosi Debug mode can be enabled through the `PSU_DEBUG` [environment variable](#with-environment-variables) and the `debug` [configuration key](#with-configuration-file). +## Contributing + +So, you want to contribute to the project: + +- Fork it +- Download your fork to your PC (git clone https://github.com/your_username/portainer-stack-utils && cd portainer-stack-utils) +- Create your feature branch (git checkout -b my-new-feature) +- Make changes and add them (git add .) +- Commit your changes (git commit -m 'Add some feature') +- Push to the branch (git push origin my-new-feature) +- Create a new pull request + +If you are submitting a complex feature, create a small design proposal on the [issue tracker](https://github.com/greenled/portainer-stack-utils/issues) before you start. + ## License Source code contained by this project is 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.