Skip to content

Latest commit

 

History

History
45 lines (33 loc) · 4.71 KB

GETTING_STARTED.md

File metadata and controls

45 lines (33 loc) · 4.71 KB
Raw

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:

Choose a working item

  1. Check the available issues (that anyone can contribute to) or first timers only issues (just for first time contributors in this project);
  2. Choose one issue you want to work on;
  3. Ask maintainers, on the issue's comment section, if you can work on it;
  4. Once you get 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 practises. 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 AnitaB.org 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!

Other ways to contribute

Do you know there are also other ways to contribute to the project besides working on an issue? As contributors, you can also:

  • 👀 help review a PR either by looking into the code and ensure that the code is clean and its logic makes sense. You can also run the app from PR branch to ensure the code works. Look for the PRs with Status: Needs Review label on the Backend and Frontend repositories.
  • 💻 test a PR by running it manually on your local machine and write a report on whether or not the PR works. Find a PR with Status: Needs testing label which is the next step after that PR is approved by the reviewer/s. Here're good examples of testing report done on one of the backend and frontend PRs.
  • 🔨 try to break the app by testing the application that runs from the existing code on the develop branch to find any bugs. If you find any, check if there is an issue already open for it, if there's none, report it on the #bridge-in-tech channel under Bugs and Fixes topic to ask if you can open one.
  • 📚 check documentations and see if any area could be improved to help contributors understand the project better. If you find something, check if there is an issue already open for it, if there's none, report it on the #bridge-in-tech channel under Documentation topic to get approval to open an issue.
  • 🎨 give suggestions on how to improve the UI design. Post your suggestion for a discussion on the #bridge-in-tech channel under Design/Mocks topic. You might get approval to work on your proposed design and have it implemented as the app UI 😁.

✨ Happy Coding !!! ✨