DigData Training

In this repository we explain the practices and standards that we use in DigData-EIRL.

Table of contents

• Work on a project
  • Pull requests
  • Commits Style Guide
  • Keep your Fork updated
• Considerations and references

Work on a project

1. Fork the project repository.
2. Create a new branch from main in your fork. You must create a branch for each ticket. Example: hotfix/login or feature/new-feature.
3. Make code changes.
4. Commit and push. Remember that the commit must be a description of the change. Example: fix: Login.
5. Make pull request from your branch to the develop branch of the main repository.
6. Wait for the change to be accepted.

It is very important to separate new features or improvements into separate feature branches, and to send a pull request for each branch.

This allow us to review and pull in new features or improvements individually.

Pull requests

All pull requests SHOULD adhere to the Conventional Commits specification.

Conventional Commits use the GitHub flow as main versioning workflow.

Commits Style Guide

The contribution guideline is derived from ConventionalCommits.org

Keep your Fork updated

When you have the Fork repository cloned on your PC, the first thing you have to do is create a remote to the original repository using: git remote add upstream <repo_url> (You only have to do this the first time you clone the repository).

Then every time a change is made in the original repository and you want to bring it to your fork use the following commands:

1. git pull upstream develop
2. git push

Note: remember to be located within the branch you wanna update.

As a good practice, it is always recommended to execute these two commands before starting to work, (just in case there is any change):

1. git pull upstream develop
2. gil pull

Considerations and references

• The commits must be well-written. Use the Conventional Commits specification for each commit.
• Every change must be documented. Use the GitHub Flavored Markdown specification to document your changes.
• GitFlow is used to manage the branches.