Skip to content

How we work with Git

We use Forking Workflow5 to collaborate in this project.

Steps to open a Pull Request

  1. Fork the repository1.
  2. Create a branch in your local copy with the name <type>/<ticket>-<description>8.
  3. Edit the files and make the commit/s.
  4. Push your changes to your branch.
  5. Open the Pull Request.3

Caution

Each Pull Request must be on top of main branch to merge it. In order to achieve this, you have to sync your fork2 and rebase4 the main branch.

How to write a commit

All the commits should follow the format of Conventional Commits6, as show in the next example:

<type>[optional scope]: <description>

[optional body]

[optional footer(s)]

How to write a good commit message

Disclaimer

This section is a summary of cbeams article: How to write a Git Commit message

TL;DR

The commit subject must complete the next sentence:

If applied, this commit will your subject line here

Example:

  • If applied, this commit will update getting started documentation
  • If applied, this commit will remove deprecated methods
  • If applied, this commit will release version 1.0.0
  • If applied, this commit will merge pull request #123 from user/branch

To write a good commit message, it should follow the next directives:

  1. Separate subject from body with a blank line
  2. Limit the subject line to 50 characters
  3. Capitalize the subject line
  4. Do not end the subject line with a period
  5. Use the imperative mood in the subject line
  6. Wrap the body at 72 characters
  7. Use the body to explain what and why vs. how

To go deeper is each point, please see the article7

  1. How to fork a repo in Github ↩

  2. How to sync a fork in Github ↩

  3. Open a Pull Request in Github ↩

  4. How to rebase a branch ↩

  5. Forking Workflow ↩

  6. Conventional Commits ↩

  7. How to write a Git Commit message ↩

  8. Example: feat/010-create_topic_endpoint ↩