Contribute to a repositoryΒΆ
When using Git you should constently keep in mind the following warning:
Warning
Never work on master, always on a branch
In order to contribute to the <reponame> repository of the <organame> organization we therefore recommand to follow the following workflow.
| Name | Description |
|---|---|
| Branch | See Create a development branch section. In order to enable code review from mainteners, the development must be short (i.e. one branch for one task such as new feature, bug fix...). |
| Work | See Work on your modifications section. In order to benefit from tools developped by mainteners and ensure code quality, the development must respect some guidelines. |
| Commit | See Commit your modifications section. Commits are snapshots of the repository. There are useful in particular for versionning software or create backups. |
| Upload ? | See Upload your modifications section. In order save your modifications into your personal repository, you should upload them. Otherwise, you can continue to add commits. |
| Submit ? | See Submit your modifications section. In order to integrate your modifications to the official repository, you must submit your modifications that will be integrated by organization mainteners. |
Note
In the following we assume that you forked the official repository in your personal account and cloned it according to previous recommendations (see Fork and clone a repository).