Skip to content

Commit

Permalink
Merge pull request #46 from France-ioi/codeChanges
Browse files Browse the repository at this point in the history
Add dev processes when working on a task.
GeoffreyHuck authored Mar 11, 2024

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
2 parents aaac35c + 7ce44e7 commit 34aa2e0
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions backend/dev-process.md
Original file line number Diff line number Diff line change
@@ -9,6 +9,26 @@ parent: Backend

# Development Processes


## Tackling a new task

1. Understand the context of the services or parts that are impacted: how it is used by the frontend, what are the parameters, what do the response contain. See [Algorea API documentation](https://france-ioi.github.io/algorea-devdoc/api/). Take the time to understand, or you might lose a lot more in later steps. **As a rule of thumb, everything you try to ignore to go faster will go against you later.**

2. Clarify the task if there is any discrepancy between what you understand from the first step, and what has to be done.

3. Once everything is clear, write the first test, and make it fail, using a TDD approach. The TDD approach might be difficult to follow in some specific cases, but it should be the default approach.

4. Make the test pass.

5. Refactor.

6. At this point, you can consider doing a commit. **The commit message must be clear and explain the choices made.**

7. If there is more to do, go back to step 3.

8. When everything is done and in a working state, follow with the checklist for a new PR.


## Checklist for a new PR

### If the change is linked to an issue present in the [Planning](https://github.com/orgs/France-ioi/projects/2):

0 comments on commit 34aa2e0

Please sign in to comment.