11. Development Workflow - gsambrotta/open-matches GitHub Wiki

To collaborate with the project, the repo must be clone. In this project we work with branch. master is the main branch, always update with production.

For each changes a new branch needs to be create. A branch must have a meaningful name, that describe which changes are applied. Branch must follow these conventions:

• feat: new feature
• fix: a bug fix or a quick fix to the code
• chore: Regular code maintenance
• refactor: code refactoring

i.e. feat-edit-profile-page i.e. fix-undefined-empty-users-list

In order to include new code changes, a Pull Request needs to be created. After review and at least one approval, the code can be merge into master.

Code will be merge with Squash and merge. Where just the most significant commits are still visible. This is the commit convention:

<issue-ID> <verb in present-tense> <rest of message (max 80 char)>

i.e. #75 fix typo in profile component

i.e. #92 create new api endpoint

If no issue is present for the current commit, we use the same convention used for branch name:

<type>: <verb in present-tense> <rest of message (max 80 char)>

i.e. feat: fetch user data and display in profile page