Skip to content

Latest commit

 

History

History
44 lines (31 loc) · 3.36 KB

CONTRIBUTING.md

File metadata and controls

44 lines (31 loc) · 3.36 KB

📖GymQuest contributing guide💪

Firstly, we want to thank you for considering contributing to our project, since it's the people like you who make the app grow better!

We are open to any type of contribution such as:

  • Proposing pull request to improve the code
  • Submitting bug/issues reports
  • Making suggestions
  • Making questions in the issue section (search to see if someone else didn't ask the same question before!)
  • Opening a discussion

To get an overview of the project, read the README.

Getting started

Submitting code

Any code change should be submitted as a pull request, with a description explaining what the code does and the steps to execute it.

Pull Request

When you're finished with the changes, create a pull request, also known as a PR.

  • Fill the "Ready for review" template so that we can review your PR. This template helps reviewers understand your changes as well as the purpose of your pull request.
  • Don't forget to link PR to issue if you are solving one.
  • Enable the checkbox to allow maintainer edits so the branch can be updated for a merge. Once you submit your PR, a Docs team member will review your proposal. We may ask questions or request additional information.
  • We may ask for changes to be made before a PR can be merged, either using suggested changes or pull request comments. You can apply suggested changes directly through the UI. You can make any other changes in your fork, then commit them to your branch.
  • As you update your PR and apply changes, mark each conversation as resolved.
  • If you run into any merge issues, checkout this git tutorial to help you resolve merge conflicts and other issues.

Code review process

The bigger the pull request, the longer it will take to review and merge. Try to break down large pull requests in smaller chunks that are easier to review and merge. It is also always helpful to have some context for your pull request. What was the purpose? Why does it matter to you?

Issues

You can create an issue for reporting problems/bugs that you may have found in the code or simply for making questions that could be useful to know for you and the rest of the users.

Create a new issue

If you spot a problem with the docs, search if an issue already exists. If a related issue doesn't exist, you can open a new issue using a relevant issue form.

Solve an issue

Scan through our existing issues to find one that interests you. You can narrow down the search using labels as filters.

Discussion

Here you can contribute by proposing ideas to add new features that you find useful, proposing topics to talk about, keeping up to date with the latest news about the app or participating in the polls!