Getting Started

Hello Newcomer, here are some tips to help you get started contributing to this project.

Get to know the project#

Here's what you can do to know more about the project:

  • Read documentation available on this website and on README.
  • You can join the #open-source-progs channel on AnitaB.org Open Source Zulip, 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 the approval you can start working on it.

Start working#

Before you start working check the Contribution Guidelines to make sure you can follow the best practices.

In short:

  1. Fork the project into your profile.
  2. Clone the project into your workspace on your computer.
  3. Setup remotes to keep your develop branch with OSP repository.
  4. Create a specific branch based from develop branch for your specific feature.
  5. Start coding.
  6. Make sure you follow this Commit Message Style Guide.
  7. Once you finish working on your issue, submit a Pull Request (PR) (following the template provided).
  8. 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).
  9. Make sure when you finish your changes you squash your commits into a single commit.
  10. Once the reviewers approve your PR, they can merge and your code will finally be part of the main repository.

Got confused? Here's a video tutorial which will help to setup the project locally.

Edit this page