Skip to content

Include additional PR guidelines #911

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

Open
voetberg wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Include additional PR guidelines #911

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion docs/contributing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,11 +108,14 @@ git commit -m "feat(Transfers): Group bulk transfers by authentication method" -
```

Add additional explanations to the body of the commit, such as motivation for
certain decisions and background information. [Here are some general rules.](https://cbea.ms/git-commit/).
certain decisions and background information. [Here are some general rules](https://cbea.ms/git-commit/).

Using multiple commits is encouraged as long as they achieve an independent,
well-defined, change and are well-described. Otherwise multiple commits should
be squashed.
When a pull request covers many components or types, use multiple commits.
For example, if a refactor is used to improve the quality of a feature, a commit with the `refactor`
isolated should included alongside the `feat` commit.
Comment on lines +117 to +118

@rdimaio rdimaio Sep 25, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wording here seems a bit off to me, maybe this improves it

Suggested change
For example, if a refactor is used to improve the quality of a feature, a commit with the `refactor`
isolated should included alongside the `feat` commit.
For example, if a refactor is used to improve the quality of a feature, a commit with the `refactor`
isolated should be included alongside the `feat` commit.

but also '...a commit with the refactorisolated' could be improved imo

@voetberg voetberg Sep 25, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah I workshopped this a few different ways and I couldn't settle on anything better. Back to the drawing board!


#### **Conventional Commits**

Expand Down Expand Up @@ -322,6 +325,9 @@ The format of the pull request title must be:
<component>: <short_change_message> #<issue number>
```

If your pull request was created with AI assistance, please disclose this in the pull request description, as required by the [AI Policy](./developer/ai_policy.md).
It is also encouraged to disclose the particular model used, if applicable.

### 5. Watch the Pull Request for reviews

Watch the pull request for comments and reviews. We expect that all continuous integration
Expand Down
Loading