Main

Change Requests

Also known as "CR" Not to be mistaken with "Pull Requests", "PR"

Guidelines

• Only create a change request if you already know what you will change in it

• Avoid conflicts: If there is any already existing open change request that is changing what you wanted to change, collaborate on them

• Don't forget to archive obsolete or accidental change requests

• Change request subject

  • Write it before making any changes

  • Naming

    • Start it with its label (Feature/Enhance/Fix/Update/Deprecate)

    • Following by ": "

    • Following by the page path of the change request, separating sub-pages with "﹣"

    • Following by "︱"

    • Following by the section path of the page of the change request, separating sub-sections with "﹣"

    • Example: the change request subject for this change is named "Feature: Documentation﹣Main︱Change Requests﹣Guidelines"

Create

Procedure

Must be done while following Guidelines

• Check for any already existing open change request that is changing what you wanted to change; If you find one: collaborate on them

  • In the space sub-navigation menu, click on the Tab "Change Requests"

  • In the change requests panel, click on the Tab "Draft" and "In Review"

  • Read all the change requests subjects to check for any already existing open change request are already changing what you wanted to change; If you find one: collaborate on them

• If every already existing open change request are not changing what you wanted to change: create a change request

• Write the subject of the change request

• Develop the changes on the change request

• When your change request is production-ready, submit it

  • If you are not sure that your change request can be published right away: you can submit it for review (recommended)

  • If you are sure that your change request can be published right away: you can submit and merge it (not recommended)

Review

Procedure

Must be done while following Guidelines

• In the space sub-navigation menu, click on the Tab "Change Requests"

• In the change requests panel, click on the Tab "In Review"

• Select the change request you want to review

• Check for any other already existing open change requests that could conflicting with your currently in-review change request; If you find some: resolve the conflicts

• Check if your currently in-review change request content is qualitative enough and is following Guidelines:

  • If it is not the case: turn the change request back to a draft change request

  • If it is the case: merge the change request

Links

• Documentation︱GitBook︱Collaboration