|
|
|
---
|
|
|
|
title: Developer guide
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
# IMPORTANT
|
|
|
|
|
|
|
|
If you have a local clone of the repository that **predates Feb. 19th, 2025, you must absolutely make a new clone**.
|
| ... | ... | @@ -24,15 +17,6 @@ All contributions are welcome. To start coding : |
|
|
|
- clone or fork the repository
|
|
|
|
- use an existing branch or create one according to the [branching workflow](#branching-workflow)
|
|
|
|
|
|
|
|
# Semantic versioning
|
|
|
|
The PASE repository follows the recommendations of [semantic versioning](https://docs.npmjs.com/about-semantic-versioning ).
|
|
|
|
A release of the software is identified with its version number vX.Y.Z following the table below.
|
|
|
|
|
|
|
|
| Position | Description | Changes | Action | Example: this version | becomes |
|
|
|
|
|----------|---------------|--------------------------------------------------|-------------------------------------------------|-----------------------|---------|
|
|
|
|
| X | Major release | Changes that break backward compatibility | Increment the 1st digit, set the following to 0 | v1.2.5 | v2.0.0 |
|
|
|
|
| Y | Minor release | Changes that do not break backward compatibility | Increment the 2nd digit, set the following to 0 | v1.2.5 | v1.3.0 |
|
|
|
|
| Z | Patch release | Backward compatible bug fixes | Increment the 3rd digit | v1.2.5 | v1.2.6 |
|
|
|
|
|
|
|
|
# Branching strategy : git-flow
|
|
|
|
source : https://nvie.com/posts/a-successful-git-branching-model/
|
| ... | ... | @@ -282,6 +266,16 @@ After a merge (either on develop, main, or any other branch) occurs on Gitlab, r |
|
|
|
|
|
|
|
Read more here: [Getting changes from a remote repository](https://docs.github.com/en/get-started/using-git/getting-changes-from-a-remote-repository)
|
|
|
|
|
|
|
|
# Semantic versioning
|
|
|
|
The PASE repository follows the recommendations of [semantic versioning](https://docs.npmjs.com/about-semantic-versioning ).
|
|
|
|
A release of the software is identified with its version number vX.Y.Z following the table below.
|
|
|
|
|
|
|
|
| Position | Description | Changes | Action | Example: this version | becomes |
|
|
|
|
|----------|---------------|--------------------------------------------------|-------------------------------------------------|-----------------------|---------|
|
|
|
|
| X | Major release | Changes that break backward compatibility | Increment the 1st digit, set the following to 0 | v1.2.5 | v2.0.0 |
|
|
|
|
| Y | Minor release | Changes that do not break backward compatibility | Increment the 2nd digit, set the following to 0 | v1.2.5 | v1.3.0 |
|
|
|
|
| Z | Patch release | Backward compatible bug fixes | Increment the 3rd digit | v1.2.5 | v1.2.6 |
|
|
|
|
|
|
|
|
# Good practices
|
|
|
|
|
|
|
|
## Coding
|
| ... | ... | |
