diff --git a/CONTRIBUTORS_GUIDE.md b/CONTRIBUTORS_GUIDE.md new file mode 100644 index 0000000..b73a252 --- /dev/null +++ b/CONTRIBUTORS_GUIDE.md @@ -0,0 +1,115 @@ +# Contributor Guidelines + +🎉 Thank you for being interested in contributing to the Gostarkme project! 🎉 + +Feel welcome and read the following sections in order to know how to ask questions and how to work on something. + +Please make sure you are welcoming and friendly in all of our spaces. + +We're really glad you're reading this, because we need volunteer developers to help this project come to fruition. 👏 + +## Issues + +The best way to contribute to our projects is by opening a new issue Here or tackling one of the issues listed here . + +# Pull Requests + +1. When picking up an issue give a brief presentation about yourself. + +``` +Template: +Hi, I'm [Your Name] and I'll be working on issue #[Issue Number]. + +I estimate this will take [Time Estimate] to complete. + +``` + +2. **Estimated Time to Completion**: Approximate number of hours or days required to complete the task. + +3. **Approach and Methodology**: Briefly outline your strategy for tackling the issue, including any relevant tools, technologies, or resources you plan to utilize + +4. Fork the repo and create a new branch for your issue in the forked repo learn more about how to fork a repository here + +5. When modifying contracts kindly make sure the formatting is correct and all tests pass successfully. + +6. Commit your changes. + +7. Push to your fork and submit a pull request on our `dev` branch. Please provide us with some explanation of why you made the changes you made. For new features make sure to explain a standard use case to us. + +## CI (Github Actions) + +We use GitHub Actions to verify if the code of your PR passes all our checks. + +When you submit your PR (or later change that code), a CI build will automatically be kicked off. A note will be added to the PR, and will indicate the current status of the build. + +## Commits + +We use Conventional Commits to add human and machine readable meaning to our commit messages. In particular, we use the Angular convention. + +Don't worry if it looks complicated. In our repositories, after adding your files with git (i.e `git add`), you can just run the `commit` script in our `package.json`, and you'll be prompted to fill out any required commit fields at commit time. We use Commitizen under the hood. + +Each commit message consists of a header, a body and a footer. The header has a special format that includes a type, a scope and a subject: + +``` +(): + + + +