Update Developer guide authored by Bouvry Arnaud's avatar Bouvry Arnaud
---
title: Developer guide
---
# Table of contents
[[_TOC_]]
# 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
- read this developer guide completely for essential information and practices to follow
- either check the issues or get in touch with the team (see Contact page) to join the collaboration
- clone the repository
- use an existing branch or create one according to the [branching workflow](#Branching-workflow)
# Good practices
- **NEVER** `git add .` or `git add -A` or `git add -A .`
......@@ -23,17 +25,19 @@ This is the process to create a new branch. It is mandatory to first create an i
![branching_workflow](uploads/1220d0698239fe6918ab1620d4a6b5c8/branching_workflow.png)
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
| Type | Description |
|----------|--------------------------------------------------------------------------------------------------------------------------------------------|
| feature | new feature |
| fix | bug fix |
| chore | changes that do not relate to a fix or feature and don't modify src or test files (for example updating dependencies) |
| refactor | refactored code that neither fixes a bug nor adds a feature |
| docs | updates to documentation such as a the README or other markdown files |
| style | changes that do not affect the meaning of the code, likely related to code formatting such as white-space, missing semi-colons, and so on. |
| test | including new or correcting previous tests |
| perf | performance improvements |
| ci | continuous integration related |
| build | changes that affect the build system or external dependencies |
| revert | reverts a previous commit |
Example issue title :
......
......