Added Contribuiting Guide and PR template checklist

.github/pull_request_template.md

@@ -1,18 +1,50 @@
-### Description
+## Pull Request Details
 
-Motivation for this PR. Linking the related issue is enough:
+Please provide a brief summary about the problem this PR is solving.
 
-Closes #...
+### Related Issue(s)
+
+- (e.g., #1234) Provide issue numbers (if applicable)
 
 ### Proposed Changes
 
-Changes that this PR will introduce. Are there any breaking changes?
+Please provide a brief summary of the changes made.
+
+### Type of Change
+
+- [ ] Bug fix
+- [ ] New feature
+- [ ] Breaking change (change that might cause existing functionality not to work as expected)
+- [ ] This change requires a documentation update
+- [ ] Refactoring
+
+### Checklist
+
+- [ ] I have read the [CONTRIBUTING](../CONTRIBUTING.md) document.
+- [ ] I have ensured that my code follows the code style of this project.
+- [ ] I have ensured that my commit messages is clear and descriptive.
+- [ ] I have performed a self-review of my own code.
+- [ ] I have commented my code when necessary, particularly in hard-to-understand areas.
+- [ ] I have made corresponding changes to the documentation or added new documentation where necessary.
+- [ ] My changes generate no new warnings or errors.
+- [ ] I have added tests that prove my fix is effective or that my feature works.
+- [ ] New and existing unit tests pass locally with my changes.
+- [ ] I Test the changes in both local and Docker/Kubernetes environments.
+- [ ] I have merged the latest changes from the main branch and resolved any conflicts.
+
+### Test Plan (if applicable)
+
+Please describe the tests that you ran to verify your changes and provide instructions so that tests can be reproduced.
+
+- [ ] Test A
+- [ ] Test B
+
+### Additional Context
 
-### Testing
+Provide any additional context or screenshots about the pull request here.
 
-How can the reviewer assert that the modifications are working as intended? A sequence of commands is just fine:
+### Merging Checklist
 
-```
-make install
-curl example.com
-```
+- [ ] I have included the `closes #issue_number` keyword in my pull request description (if relevant).
+- [ ] My code has been reviewed and approved by at least one other contributor.
+- [ ] I have merged the latest changes from the main branch and resolved any conflicts.

CONTRIBUTING.md

@@ -5,6 +5,44 @@ email, or any other method with the owners of this repository before making a ch
 
 Please note we have a code of conduct, please follow it in all your interactions with the project.
 
+## How to Contribute
+
+Thank you for your interest in improving our project! Whether you're fixing bugs, adding new features, or updating documentation, your contributions are deeply valued. Follow the steps outlined in this section to ensure a seamless contribution process.
+
+### Setting up Your Local Development Environment
+
+1. **Local Setup**:
+   - Start by setting up a local environment. We recommend using Docker Compose. Detailed steps can be found in our [local environment setup guide](https://huskyci.opensource.globo.com/docs/development/set-up-environment).
+2. **Compatibility**:
+   - Ensure your changes are compatible with both the Docker API and Kubernetes. Proper integration with these platforms is vital.
+3. **Common Issues**:
+   - As with any development process, you might face challenges or run into issues. Refer to our [Troubleshooting](README.md#troubleshooting) for tips on addressing common problems at the troubleshooting section.
+
+### Contribution Checklist
+
+- [ ] **Code Changes**:
+  - Follow the coding conventions and style guidelines of the project. Remember to test your changes thoroughly.
+- [ ] **Testing Procedures**:
+  - Make sure existing unit tests pass. Additionally, write tests for your new features or bug fixes. Test compatibility with both Docker and Kubernetes.
+- [ ] **Local Environment Considerations**:
+  - Test your changes in a local environment and make sure your changes work in both Docker and Kubernetes environments.
+
+### Seeking Assistance
+
+If you encounter difficulties or have questions:
+
+1. **Communication Channels**:
+
+   - Reach out to us through our designated communication platforms:
+     - [GitHub Issues](https://github.com/globocom/huskyCI/issues)
+     - [Gitter](https://gitter.im/globocom/huskyCI)
+     - [Twitter](https://twitter.com/huskyCI)
+
+2. **Documentation**:
+   - Our [official documentation page](https://huskyci.opensource.globo.com/docs/quickstart/overview) provides comprehensive guides and resources that might address your queries.
+3. **Community Assistance**:
+   - Engage with our community on forums and chats. Your fellow contributors can offer valuable insights and solutions.
+
 ## Pull Request Process
 
 1. Ensure any install or build dependencies are removed before the end of the layer when doing a
@@ -32,21 +70,21 @@ orientation.
 Examples of behavior that contributes to creating a positive environment
 include:
 
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
 
 Examples of unacceptable behavior by participants include:
 
-* The use of sexualized language or imagery and unwelcome sexual attention or
-advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic
+- The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic
   address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
+- Other conduct which could reasonably be considered inappropriate in a
   professional setting
 
 ### Our Responsibilities

README.md

@@ -10,7 +10,7 @@
 <a href="https://defectdojo.readthedocs.io/en/latest/integrations.html#huskyci-report"><img src="https://img.shields.io/badge/DefectDojo-Compatible-brightgreen"/></a>
 </p>
 
-*This article can also be read in [Brazilian Portuguese](README-ptBR.md).*
+_This article can also be read in [Brazilian Portuguese](README-ptBR.md)._
 
 ## Introduction
 
@@ -86,6 +86,10 @@ All guides and the full documentation can be found in the [official documentatio
 
 Read our [contributing guide](https://github.com/globocom/huskyCI/blob/master/CONTRIBUTING.md) to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes to huskyCI.
 
+## Troubleshooting
+
+If you encounter a problem, please reach out to us at [GitHub Issues](https://github.com/globocom/huskyCI/issues) or [Gitter](https://gitter.im/globocom/huskyCI). And if you have found a solution for a commom problem, please add the problem and the solution Hher
+
 ## Communication
 
 We have a few channels for contact, feel free to reach out to us at:
@@ -100,7 +104,7 @@ We have a few channels for contact, feel free to reach out to us at:
 <table><tr><td align="center"><a href="https://github.com/rafaveira3"><img src="https://avatars.githubusercontent.com/u/8943477?v=4" width="100" style="border-radius: 50%;"><br>rafaveira3</a></td><td align="center"><a href="https://github.com/Krlier"><img src="https://avatars.githubusercontent.com/u/40367872?v=4" width="100" style="border-radius: 50%;"><br>Krlier</a></td><td align="center"><a href="https://github.com/carlosljr"><img src="https://avatars.githubusercontent.com/u/25513224?v=4" width="100" style="border-radius: 50%;"><br>carlosljr</a></td><td align="center"><a href="https://github.com/spimpaov"><img src="https://avatars.githubusercontent.com/u/22274988?v=4" width="100" style="border-radius: 50%;"><br>spimpaov</a></td><td align="center"><a href="https://github.com/joserenatosilva"><img src="https://avatars.githubusercontent.com/u/11424945?v=4" width="100" style="border-radius: 50%;"><br>joserenatosilva</a></td></tr><tr><td align="center"><a href="https://github.com/janiltonmaciel"><img src="https://avatars.githubusercontent.com/u/987588?v=4" width="100" style="border-radius: 50%;"><br>janiltonmaciel</a></td><td align="center"><a href="https://github.com/gabriel-cantergiani"><img src="https://avatars.githubusercontent.com/u/27586618?v=4" width="100" style="border-radius: 50%;"><br>gabriel-cantergiani</a></td><td align="center"><a href="https://github.com/marcelomagina"><img src="https://avatars.githubusercontent.com/u/12450277?v=4" width="100" style="border-radius: 50%;"><br>marcelomagina</a></td><td align="center"><a href="https://github.com/nettoclaudio"><img src="https://avatars.githubusercontent.com/u/7503687?v=4" width="100" style="border-radius: 50%;"><br>nettoclaudio</a></td><td align="center"><a href="https://github.com/edersonbrilhante"><img src="https://avatars.githubusercontent.com/u/1094995?v=4" width="100" style="border-radius: 50%;"><br>edersonbrilhante</a></td></tr><tr><td align="center"><a href="https://github.com/GabhenDM"><img src="https://avatars.githubusercontent.com/u/38007503?v=4" width="100" style="border-radius: 50%;"><br>GabhenDM</a></td><td align="center"><a href="https://github.com/mdjunior"><img src="https://avatars.githubusercontent.com/u/3290669?v=4" width="100" style="border-radius: 50%;"><br>mdjunior</a></td><td align="center"><a href="https://github.com/gustavocovas"><img src="https://avatars.githubusercontent.com/u/11429002?v=4" width="100" style="border-radius: 50%;"><br>gustavocovas</a></td><td align="center"><a href="https://github.com/rodrigo-brito"><img src="https://avatars.githubusercontent.com/u/7620947?v=4" width="100" style="border-radius: 50%;"><br>rodrigo-brito</a></td><td align="center"><a href="https://github.com/vitoriario"><img src="https://avatars.githubusercontent.com/u/17754098?v=4" width="100" style="border-radius: 50%;"><br>vitoriario</a></td></tr><tr><td align="center"><a href="https://github.com/fguisso"><img src="https://avatars.githubusercontent.com/u/5755568?v=4" width="100" style="border-radius: 50%;"><br>fguisso</a></td><td align="center"><a href="https://github.com/abzcoding"><img src="https://avatars.githubusercontent.com/u/10992695?v=4" width="100" style="border-radius: 50%;"><br>abzcoding</a></td><td align="center"><a href="https://github.com/lzakharov"><img src="https://avatars.githubusercontent.com/u/26368218?v=4" width="100" style="border-radius: 50%;"><br>lzakharov</a></td><td align="center"><a href="https://github.com/arnaudlanna"><img src="https://avatars.githubusercontent.com/u/11250299?v=4" width="100" style="border-radius: 50%;"><br>arnaudlanna</a></td><td align="center"><a href="https://github.com/brenol"><img src="https://avatars.githubusercontent.com/u/7342697?v=4" width="100" style="border-radius: 50%;"><br>brenol</a></td></tr><tr><td align="center"><a href="https://github.com/chinchila"><img src="https://avatars.githubusercontent.com/u/3947315?v=4" width="100" style="border-radius: 50%;"><br>chinchila</a></td><td align="center"><a href="https://github.com/LuanaGP"><img src="https://avatars.githubusercontent.com/u/34948516?v=4" width="100" style="border-radius: 50%;"><br>LuanaGP</a></td><td align="center"><a href="https://github.com/Lucbm99"><img src="https://avatars.githubusercontent.com/u/45500959?v=4" width="100" style="border-radius: 50%;"><br>Lucbm99</a></td><td align="center"><a href="https://github.com/mportela"><img src="https://avatars.githubusercontent.com/u/1304652?v=4" width="100" style="border-radius: 50%;"><br>mportela</a></td><td align="center"><a href="https://github.com/marcelometal"><img src="https://avatars.githubusercontent.com/u/665903?v=4" width="100" style="border-radius: 50%;"><br>marcelometal</a></td></tr><tr><td align="center"><a href="https://github.com/aranhams"><img src="https://avatars.githubusercontent.com/u/18319426?v=4" width="100" style="border-radius: 50%;"><br>aranhams</a></td><td align="center"><a href="https://github.com/ragoso"><img src="https://avatars.githubusercontent.com/u/9319775?v=4" width="100" style="border-radius: 50%;"><br>ragoso</a></td><td align="center"><a href="https://github.com/rafaelsq"><img src="https://avatars.githubusercontent.com/u/1598854?v=4" width="100" style="border-radius: 50%;"><br>rafaelsq</a></td><td align="center"><a href="https://github.com/rafaelrubbioli"><img src="https://avatars.githubusercontent.com/u/15738138?v=4" width="100" style="border-radius: 50%;"><br>rafaelrubbioli</a></td><td align="center"><a href="https://github.com/renatoaquino"><img src="https://avatars.githubusercontent.com/u/516453?v=4" width="100" style="border-radius: 50%;"><br>renatoaquino</a></td></tr></table>
 <!-- CONTRIBUTORS_END -->
 
-This project exists thanks to all the [contributors]((https://github.com/globocom/huskyCI/graphs/contributors)). You rock!   ❤️🚀
+This project exists thanks to all the [contributors](<(https://github.com/globocom/huskyCI/graphs/contributors)>). You rock! ❤️🚀
 
 ## License