debian-mirror-gitlab/.gitlab/issue_templates/Doc_cleanup.md
2022-10-11 01:57:18 +05:30

4.1 KiB

If you are a community contributor, do not work on the issue if it is not assigned to you yet.

Additionally, please review these points before working on this issue:

  1. If you would like to work on the issue, type @gl-docsteam I would like to work on this issue. in a comment. A technical writer will assign the issue to you. If someone has already chosen this issue, pick another issue, or view docs in the docs directory and open a merge request for any page you feel can be improved.
  2. Carefully review the merge request guidelines for contributors.
  3. Carefully review the commit message guidelines.
  4. Create a merge request for the issue:
    • If you were not assigned the issue, do not create a merge request. It will not be accepted.
    • If this is for a Hackathon, do not create the merge request before the Hackathon has started or it will not be counted towards the Hackathon.
    • Unless otherwise stated below, we expect one merge request per issue, so combine all changes together. If there is too much work for you to handle in one merge request, you can create more, but try to keep the number of merge requests as small as possible.
    • Select the Documentation merge request description template, and fill it out with the details of your work.
    • Copy the link to this issue and add it to the merge request's description, which links the merge request and the issue together.
  5. After your merge request is accepted and merged, close this issue.

If you notice things you'd like to fix that are not part of the issue, open separate merge requests for those issues.

We're sorry for all the rules but we want everyone to have a good experience, and it can be hard when we get an influx of contributions.

Thank you again for contributing to the GitLab documentation!

Identified documentation issue

Additional information

Who can address the issue

/label ~documentation