Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(contrib): add notes on dealing with merge conflicts #13634

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

agilgur5
Copy link
Member

@agilgur5 agilgur5 commented Sep 20, 2024

Addresses some of my comments in #13631 (comment) and adds some things I've noted on Slack before too

Motivation

Add two small best practices for dealing with merge conflicts that I've been using

  • can add more to this section later as we iron them out

Plus clarify a contradictory piece that may have confused Alan

Modifications

  • split out a "Merge Conflicts" section for this
    • fix up some formatting in the existing sentence to match the docs style guide
    • add what to do if you're not sure how to fix it: don't backport it is the safer option
    • add instruction to add a note in the commit if you did fix a merge conflict
      • add prior examples of this as well

Other modifications

  • remove chore(deps), build, and ci from the "list of commits"

  • add docs to this list since we now have versioned documentation Versioned documentation #11390

    • i.e. docs-only improvements unrelated to a feature should also be backported when possible, as previously discussed and as I've done many times now and Alan's done a few times now too
  • add note about pinning release announcements in Slack

    • use the specific terms that the Slack UI uses: "Pin" and "Un-pin"
    • this is something new I've been doing recently

Verification

make docs passes

- split out a "Merge Conflicts" section for this
  - fix up some formatting in the existing sentence to match the docs style guide
  - add what to do if you're not sure how to fix it: don't backport it is the safer option
  - add instruction to add a note in the commit if you did fix a merge conflict
    - add prior examples of this as well

- remove `chore(deps)`, `build`, and `ci` from the "list of commits"
  - matching the "Ignore: " below from argoproj@7e69527
  - these also tend to cause the most merge conflicts, directly or indirectly

- add note about pinning release announcements in Slack
  - use the specific terms that the Slack UI uses: "Pin" and "Un-pin"

Signed-off-by: Anton Gilgur <[email protected]>
@agilgur5 agilgur5 added the area/contributing Contributing docs, ownership, etc. Also devtools like devcontainer and Nix label Sep 20, 2024
@agilgur5 agilgur5 changed the title docs(contrib): add notes on dealing with merge conflicts docs(releasing): add notes on dealing with merge conflicts Sep 20, 2024
@agilgur5 agilgur5 changed the title docs(releasing): add notes on dealing with merge conflicts docs(contrib): add notes on dealing with merge conflicts Sep 20, 2024
Signed-off-by: Anton Gilgur <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/contributing Contributing docs, ownership, etc. Also devtools like devcontainer and Nix
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant