Changes
Page history
Update Developer guide
authored
Jan 30, 2025
by
Bouvry Arnaud
Show whitespace changes
Inline
Side-by-side
documentation/dev-guide.md
View page @
1bc34db7
---
---
title
:
Developer guide
title
:
Developer guide
---
---
# Table of contents
# Table of contents
[[
_TOC_
]]
[[
_TOC_
]]
# Joining the developers of PASE
# Joining the developers of PASE
All contributions are welcome. To start coding :
All contributions are welcome. To start coding :
-
check the developer guide for essential informations and practices to follow
-
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 below) to prepare the collaboration
-
either check the issues or get in touch with the team (see Contact page) to join the collaboration
-
use an existing branch or create one according to the branching workflow
-
clone the repository
-
use an existing branch or create one according to the
[
branching workflow
](
#Branching-workflow
)
# Good practices
# Good practices
-
**NEVER**
`git add .`
or
`git add -A`
or
`git add -A .`
-
**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
...
@@ -23,17 +25,19 @@ This is the process to create a new branch. It is mandatory to first create an i
Create an issue with a title containing one of the following keywords in square brackets as prefix :
Create an issue with a title containing one of the following keywords in square brackets as prefix :
-
feature
| Type | Description |
-
fix
|----------|--------------------------------------------------------------------------------------------------------------------------------------------|
-
chore
| feature | new feature |
-
refactor
| fix | bug fix |
-
docs
| chore | changes that do not relate to a fix or feature and don't modify src or test files (for example updating dependencies) |
-
style
| refactor | refactored code that neither fixes a bug nor adds a feature |
-
test
| docs | updates to documentation such as a the README or other markdown files |
-
perf
| 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. |
-
ci
| test | including new or correcting previous tests |
-
build
| perf | performance improvements |
-
revert
| ci | continuous integration related |
| build | changes that affect the build system or external dependencies |
| revert | reverts a previous commit |
Example issue title :
Example issue title :
...
...
...
...
