Skip to content

Commit

Permalink
[MRG] Merge pull request #416 from dfir-iris/workflow_documentation
Browse files Browse the repository at this point in the history
[DOC] Started documentation of the git workflow
  • Loading branch information
whikernel authored Feb 29, 2024
2 parents a99c78a + 6879cea commit 3c5b0dc
Showing 1 changed file with 23 additions and 6 deletions.
29 changes: 23 additions & 6 deletions CODESTYLE.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,29 @@

If you wish to develop in DFIR-IRIS, please make sure to read the following tips.

## Workflow

- development is done on branch `develop`
```
git switch develop
```
- safe and small modifications may be directly performed on branch `develop`
- modifications which either imply more work or are risky, must be performed on a branch of their own
```
git switch -c <branch-name>
git push --set-upstream origin <branch-name>
```
- when work on the branch is ready to be published, then a pull request (PR) is created from the github interface.
Do not forget to choose `develop` as the base branch (by default it is set to `master`,
more information [here](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request#changing-the-branch-range-and-destination-repository)).


### Commits
Try to follow the repository convention:

- If it's not linked to an issue, use the format `[action] Commit message`, with `action` being a 3 letters action related to the commit, eg `ADD`for additions, `DEL` for deletions, `IMP` for improvements, etc.
- If it's linked to an issue, prepend with the issue ID, i.e `[#issue_id][action] Commit message`

## License header

New files should be prefixed by the following license header, where `${current_year}` is replaced by the current year
Expand Down Expand Up @@ -33,12 +56,6 @@ New files should be prefixed by the following license header, where `${current_y
#!/usr/bin/env python3
```

## Commits
Try to follow the repository convention :

- If it's not linked to an issue, use the format `[action] Commit message`, with `action` being a 3 letters action related to the commit, eg `ADD`for additions, `DEL` for deletions, `IMP` for improvements, etc.
- If it's linked to an issue, prepend with the issue ID, i.e `[#issue_id][action] Commit message`

## Code
The code should be pretty easy to apprehend. It's not perfect but it will improve over time.
Some documentation about development is available [here](https://docs.dfir-iris.org/development/).
Expand Down

0 comments on commit 3c5b0dc

Please sign in to comment.