Getting Started
Hello Newcomer, here are some tips to help you get started contributing to this project.
#
Get to know the projectHere's what you can do to know more about the project:
- Read Documentation available on Mentorship Backend Docs and README;
- You can join the #mentorship-system channel on Systers Open Source Slack, to see or participate in the project's discussion;
- You can browse the code on GitHub or even on your workspace after cloning it.
#
Choose a working item- Check the available issues (that anyone can contribute to) or first timers only issues (just for first time contributors in this project);
- Choose one issue you want to work on;
- Ask maintainers, on the issue's comment section, if you can work on it;
- Once you get approval you can start working on it.
#
Start workingBefore you start working check the Contribution Guidelines to make sure you can follow the best practises.
In short:
- Fork the project into your profile;
- Clone the project into your workspace on your computer;
- Setup remotes to keep your
develop
branch with systers repository; - Create a specific branch based from
develop
branch for your specific feature; - Start coding;
- Make sure you follow this Commit Message Style Guide;
- Once you finish working on your issue, submit a Pull Request (PR) (following the template provided);
- If the reviewers request changes on your PR, make the changes (this can be a back and forth process where you make changes according to reviewers feedback);
- Make sure when you finish your changes you squash your commits into a single commit;
- Once the reviewers approve your PR, they can merge and your code will finally be part of the main repository.