Skip to content

Commit

Permalink
update: contributing
Browse files Browse the repository at this point in the history
  • Loading branch information
olivmath committed Dec 31, 2023
1 parent d1764fa commit 4dd9dc2
Showing 1 changed file with 13 additions and 22 deletions.
35 changes: 13 additions & 22 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,45 +2,36 @@

## WORKFLOW

1. Create and describe your **proposal/bug** in an _issue_.
2. Create a new **branch** and **pull request** with the pattern `1-my-feature`.
1. Create your **proposal/bug** in an _issue_.
2. Create a new **branch** and **pull request** with the pattern:
- `feat/my-new-feature`.
- `docs/add-new-docs`.
- `test/add-a-test`.
- `fix/big-bug`.
3. Open a PR for you _issue_ (or link with a existent)
4. Await to `merge`
5. Publish new change by `tag`

<img width="1172" alt="Gitlab Flow" src="https://user-images.githubusercontent.com/50037567/165442258-072abfe6-2295-40d6-a573-92f851878c4c.png">

---

## DEVELOPMENT ENVIRONMENT

**pre-req**

- [docker](https://docs.docker.com/engine/install/)
- [vscode](https://code.visualstudio.com/download)
- [remote container](https://code.visualstudio.com/docs/remote/containers)

1. Update the image with `Dockerfile`
2. Development and test inside a container before do `git push`

<img width="784" alt="envdev" src="https://user-images.githubusercontent.com/50037567/167924906-e9791796-c673-49b6-957b-493b33745907.png">

---

## CONVENTIONAL COMMIT

```
type(escope): short description
What does the modification do?
why was it modified?
You need describe better?
Write more here
```

type

- **deprecated!** compatibility break
- **add** adds a new feature
- **fix** fixes a bug
- **remove** remove a peace of code
- **update** does not add a feature or fix a bug
- **remove** remove a peace of code
- **security** update/fix some security matter code

---

Expand Down

0 comments on commit 4dd9dc2

Please sign in to comment.