Remember to contributors that should use their own branches

[skip ci] To avoid that when an unauthenticated user sends us a merge
request we have to manually select the pipeline stages to be executed or
not, we remind them to create their own branches.
This commit is contained in:
Óscar García Amor 2022-07-15 09:41:16 +02:00
parent d6c8e05d4c
commit f6ed5a4ff8
No known key found for this signature in database
GPG Key ID: E18B2370D3D566EE

View File

@ -15,27 +15,34 @@ Interested in help to translate Ultrasonic? You can contribute in our
## Contributing Code
By default Pull Request should be opened against **develop** branch, PR
against **master** branch should be used only for critical bugfixes.
By default, merge requests should be opened against the **develop** branch
from your own branch, MR against the **master** branch should only be used
for critical bug fixes.
### Here are a few guidelines you should follow before submitting:
1. **License Acceptance:** All contributions must be licensed as [GNU
GPLv3](LICENSE) to be accepted. Use `git commit --signoff` to acknowledge
this.
2. **No Breakage:** New features or changes to existing ones must not
2. **No Breakage**: New features or changes to existing ones must not
degrade the user experience.
3. **Coding standards:** best-practices should be followed, comment
3. **Coding standards**: best-practices should be followed, comment
generously, and avoid "clever" algorithms. Refactoring existing messes is
great, but watch out for breakage.
4. **No large PR:** Try to limit the scope of PR only to the related issue,
4. **No large PR**: Try to limit the scope of PR only to the related issue,
so it will be easier to review and test.
5. **Make your own branch**: When you send us a merge request, please do it
from your own branch. Avoid using the `develop` branch.
### Pull Request Process
### Merge request process
On each Pull Request GitLab runs a number of checks to make sure there are
On each merge request GitLab runs a number of checks to make sure there are
no problems.
Take special note of point five of the previous paragraph. Do not use the
`develop` branch, make your own. Not following this step will cause your
merge request to be rejected without even checking it.
#### Signed commits
Commits must be signed. [See here how to set it