Developer readme

Development workflow

Release policy

The development team works on a branch named main.

Whenever a feature needs to be implemented, a new branch (feat/<new_branch>) must be pulled from main and rebased to this later once the feature is ready.

graph TD
    .. --main--> 1
    1 --> 2
    2 --> 3
    3 --> 4
    1 --feat/my-feature--> 2bis
    2bis --> 3bis
    3bis --> 4bis

Loading

Then, we will approve your changes and we will push these changes to main.

Depending on which improvements you will bring to the plugin, you will have to choose the right gitmoji in your PR name in order to publish a new version.

graph TD
    .. --feat/my-feature--> 1
    1 --> 2
    2 --> 3
    3 --> 4
    4 --> 2bis
    2bis --> 3bis
    3bis --> 4bis

Loading

Explanations:

Before each new feature, run:

git checkout main
git pull

Create a new branch feat/<branch name> for the feature

git checkout -b feat/<branch name>

Once the feature is implemented, create a pull request to get the approval of a reviewer. If it's approved, your feature will be squash and merge feat/<branch name> to main.

See contributing rules here.

/!\ Don't forget to pull the updated pom.xml once the release job is done. /!\

git pull