Skip to content

Commit 57e5752

Browse files
committed
update: contributing
1 parent 4f2ccac commit 57e5752

File tree

1 file changed

+13
-22
lines changed

1 file changed

+13
-22
lines changed

CONTRIBUTING.md

+13-22
Original file line numberDiff line numberDiff line change
@@ -2,45 +2,36 @@
22

33
## WORKFLOW
44

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

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

1017
---
1118

12-
## DEVELOPMENT ENVIRONMENT
13-
14-
**pre-req**
15-
16-
- [docker](https://docs.docker.com/engine/install/)
17-
- [vscode](https://code.visualstudio.com/download)
18-
- [remote container](https://code.visualstudio.com/docs/remote/containers)
19-
20-
1. Update the image with `Dockerfile`
21-
2. Development and test inside a container before do `git push`
22-
23-
<img width="784" alt="envdev" src="https://user-images.githubusercontent.com/50037567/167924906-e9791796-c673-49b6-957b-493b33745907.png">
24-
25-
---
26-
2719
## CONVENTIONAL COMMIT
2820

2921
```
3022
type(escope): short description
3123
32-
What does the modification do?
33-
why was it modified?
34-
24+
You need describe better?
25+
Write more here
3526
```
3627

3728
type
3829

39-
- **deprecated!** compatibility break
4030
- **add** adds a new feature
4131
- **fix** fixes a bug
42-
- **remove** remove a peace of code
4332
- **update** does not add a feature or fix a bug
33+
- **remove** remove a peace of code
34+
- **security** update/fix some security matter code
4435

4536
---
4637

0 commit comments

Comments
 (0)