Extend documentation on how to contribute with code changes
As a .Net developer I need to have more information on the convention of the process to contribute to code changes:
- Rebase feature branch vs merge develop to feature branch
- Commint comments and references to tickets
- Squash commits
Tasks
-
Extend the documentation "Development guidelines", to include detail information on the three points above specifiyng: -
When creating a new merge request, the request should not be conflicting and the authomatic validation tests should be passing. -
In the future the merge request might start conflicting. In this case, the person peer-reviewing the related ticket, will initialize the process of conflict resolution. Depending on the case, the conflict resolution might be done by the peer-reviewer, the original implementer or various other developers involved.
-
-
Quality of the description in the Merge request: -
The description of a marge request should contain information related to what is being changed and the URL to link to the gitlab ticket. -
In case of multiple commits of a merge request, the peer-reviewer should squash the commits on the target develop branch.
-
-
The contributor is free to choose between merging develop to feature branch or rebasing the feature branch on top of develop to resolve conflicts; before the merge request is created.
-
Note that the conventions above, might only apply to the .Net team. If this is the case, create a new section to specify in the documentation.
Edited by Cristian Garcés