Skip to content

docs: contribute: update how-to-submit-patches section for monorepo

Tim-Philipp Müller requested to merge tpm/gstreamer:docs-contributing into main

See comment by @hacpa:

  1. In the section about creating a fork of the repository, a mention of the visibility level should be added. The default setting in gitlab is "Private", so that's what I used. Not sure if it matters to you?
  2. The default branch of the main "gstreamer" is confusing: the branch that gets checked out automatically is "main" and it contains all the modules. "master", however, contains only what I expected. The instructions say to create merge requests against "master", which is what I did. Do you think the "main" VS "master" thing should be explained somewhere? Or maybe just put more emphasis on the fact that "master" should be used?
  3. Merge requests, by default, pick the "main" branch when initially created. See above.
  4. I could not select "Allow commits from members who can merge to the target branch" as my fork is private. This ties with question 1.
  5. The information for creating a branch and pushing is duplicated in the document. The first set is under "Where to Submit Patches" and the second set is under "Creating a branch for the merge request and adding commits to it". The second set contains an error. If you follow the instructions under that section, you will have cloned your own fork directly, instead of cloning the main repository and adding another origin URL to it. So, in this case, the origin will be named "origin". So, typing "git push your-personal-gitlab-fork your-branch" doesn't work: you have to type "git push origin your-branch".
  6. Another duplication/conflict: One section of the document says to add a "Fixes #123" to the commit message when the commit relates to an issue on the bug tracker. Later on in the document, another section says to add the full URL to the bug tracker. Not knowing which one is correct, I went with the "Fixes #123" format.
Edited by Tim-Philipp Müller

Merge request reports