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.

Sign up for GitHub

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

Jump to bottom

cleanup: update contributing guide #11861

Merged
merged 6 commits into from
Dec 28, 2023
Merged

cleanup: update contributing guide #11861

merged 6 commits into from
Dec 28, 2023

Conversation

kbdharun
Copy link
Member

@kbdharun kbdharun commented Dec 27, 2023 •
edited
Loading

  • The PR title conforms to the recommended templates.

This PR updates the contributing guide to complete the remaining tasks in the tracker issue.

Changes

  • Document methods to reference subcommands (update examples).
  • Add tip when fixing typos in translations the page must be updated to match with the English page.
  • Document how to deal with name collisions. (I intentionally added it to the last section of the page as we wouldn't be referring to this frequently)

@kbdharun kbdharun requested a review from sbrl as a code owner December 27, 2023 12:56
@github-actions github-actions bot added the documentation Issues/PRs modifying the documentation. label Dec 27, 2023
@kbdharun kbdharun mentioned this pull request Dec 27, 2023
Closed
70 tasks
kbdharun
kbdharun commented Dec 27, 2023
View reviewed changes
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
sebastiaanspeck
sebastiaanspeck reviewed Dec 27, 2023
View reviewed changes
CONTRIBUTING.md Outdated Show resolved Hide resolved
kbdharun
kbdharun commented Dec 27, 2023
View reviewed changes
CONTRIBUTING.md Outdated Show resolved Hide resolved
sebastiaanspeck
sebastiaanspeck reviewed Dec 28, 2023
View reviewed changes
CONTRIBUTING.md Outdated Show resolved Hide resolved
@sebastiaanspeck sebastiaanspeck merged commit f91917f into main Dec 28, 2023
8 checks passed
@sebastiaanspeck sebastiaanspeck deleted the docs/contributing branch December 28, 2023 16:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sebastiaanspeck sebastiaanspeck sebastiaanspeck approved these changes

@gutjuri gutjuri gutjuri approved these changes

@sbrl sbrl Awaiting requested review from sbrl sbrl is a code owner

Assignees
No one assigned
Labels
documentation Issues/PRs modifying the documentation.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@kbdharun @sebastiaanspeck @gutjuri