From 5620753491903617f73ab505e0bce13e4d254a58 Mon Sep 17 00:00:00 2001 From: Fabien COMBERNOUS <fabien.combernous@adullact.org> Date: Mon, 14 Nov 2022 09:14:40 +0100 Subject: [PATCH] add contributing guide --- CONTRIBUTING.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..4863e4c --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,25 @@ +If you follow these contributing guidelines your patch +will likely make it into a release a little more quickly. + +## Contributing + +1. Fork the repo. + +2. Create a separate branch for your change. + +3. We only take pull requests with passing tests, and documentation. You can also execute them locally. + +4. Checkout [Voxpupuli review docs](https://voxpupuli.org/docs/#reviewing-a-module-pr). We try to + use it to review a merge request and the [official styleguide](https://puppet.com/docs/puppet/6.0/style_guide.html). + They provide some guidance for new code that might help you before you submit a merge request. + +5. Add a test for your change. Only refactoring and documentation + changes require no new tests. If you are adding functionality + or fixing a bug, please add a test. + +6. Squash your commits down into logical components. Make sure to rebase + against our current master. + +7. Push the branch to your fork and submit a merge request. + +Please be prepared to repeat some of these steps as your code is reviewed. -- GitLab