Skip to content

Latest commit

 

History

History
88 lines (55 loc) · 2.88 KB

GUIDELINES.md

File metadata and controls

88 lines (55 loc) · 2.88 KB

Guidelines

Table of Contents

Code of Conduct

We adopted the Contributor Covenant as the Code of Conduct of our projects.

Git

Branch

We have adopted rules on the use and nomenclature of branches. These rules are inspired from the Gitflow and GitHub flow workflows.

main

This branch contains the latest stable version. This branch is subject to restrictions.

develop

This branch contains the version under development. This branch is subject to restrictions.

It is created from and merge in main.

hot/

These branches correspond to the correction of a critical bug.

They are created from and merge in main.

bug/

These branches correspond to the correction of a bug.

They are created from and merge in develop.

feature/

These branches correspond to the development of a feature or an improvement.

They are created from and merge in develop.

Commit

We have adopted the Conventional Commit as our commit message standard. It helps maintain a clear and accurate history of changes made.

Submission

Issue

Before submitting a new issue, make sure there are no similar ones to yours, open or not. If a similar issue exists, comment only if you have additional information that would be useful in resolving it. If not, open a new issue and follow the template steps.

Pull Request

Before submitting a new pull request, make sure there are no existing features or pull requests similar to yours. If a similar pull request exists, contribute only if you have useful features to add to it. If not, follow these steps:

  1. Open a new issue by following the Issue section
  2. Fork the repository
  3. Create a new branch by following the Branch section of the Git Guidelines
git checkout -b <branch-name>
  1. Make your changes by following the project Code Guidelines
  2. Commit your changes by following the Commit section of the Git Guidelines
  3. Push your branch
git push <branch-name>
  1. Create a new pull request and follow the template steps.