diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e3dc35e..e9cd798 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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` Gitlab Flow --- -## 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` - -envdev - ---- - ## 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 ---