|
|
---
|
|
---
|
|
|
title: Developer guide
|
|
title: Developer guide
|
|
|
---
|
|
---
|
|
|
|
# Joining the developers of PASE
|
|
|
|
All contributions are welcome. To start coding :
|
|
|
|
- check the developer guide for essential informations and practices to follow
|
|
|
|
- either check the issues or get in touch with the team (see Contact below) to prepare the collaboration
|
|
|
|
- use an existing branch or create one according to the branching workflow
|
|
|
|
|
|
|
|
# Good practices
|
|
|
|
- **NEVER** `git add .` or `git add -A` or `git add -A .`
|
|
|
|
|
|
|
|
# Branching strategy : git-flow
|
|
|
|
2 permanent branches : main and develop
|
|
|
|
|
|
|
|
# Branching workflow
|
|
|
|
|
|
|
|
This is the process to create a new branch. It is mandatory to first create an issue on Gitlab, create the branch from within the issue, then pull locally.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Create an issue with a title containing one of the following keywords in square brackets as prefix :
|
|
|
|
- feature
|
|
|
|
- fix
|
|
|
|
- chore
|
|
|
|
- refactor
|
|
|
|
- docs
|
|
|
|
- style
|
|
|
|
- test
|
|
|
|
- perf
|
|
|
|
- ci
|
|
|
|
- build
|
|
|
|
- revert
|
|
|
|
|
|
|
|
Example issue title :
|
|
|
|
|
|
|
|
[feature] Implement algorithm Foo bar
|
|
|
|
|
|
|
|
Select an issue template (feature request or bug report) and fill all fields as clearly and concisely as possible. |
|
|
|
\ No newline at end of file |
