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

Pull Request guidelines #293

Open
wants to merge 34 commits into
base: main
Choose a base branch
from
Open
Changes from 1 commit
Commits
Show all changes
34 commits
Select commit Hold shift + click to select a range
a17039e
Add PR conventions file
kin0992 Feb 19, 2025
0599019
Update website/docs/conventions/pull-request.md
kin0992 Feb 19, 2025
7d1307a
Add reason why title should not contain Jira task id
kin0992 Feb 19, 2025
aec329a
Improve breaking change description
kin0992 Feb 19, 2025
6ce3ec5
Create guidelines section
kin0992 Feb 19, 2025
5d07c98
Start Git section
kin0992 Feb 19, 2025
3136ee6
Add short description
kin0992 Feb 19, 2025
1449636
Improve sentence
kin0992 Feb 19, 2025
36da4ad
Update changeset file
kin0992 Feb 19, 2025
2ff812d
Update PR format and front matter
kin0992 Feb 20, 2025
f049487
Add examples on PR description format
kin0992 Feb 20, 2025
f99112f
Remove files that have been moved in a separate PR
kin0992 Feb 20, 2025
e55fae2
Update description
kin0992 Feb 20, 2025
e5916d0
Remove size criteria
kin0992 Feb 20, 2025
e4953da
Update heading type
kin0992 Feb 20, 2025
f4566dc
Fix formatting
kin0992 Feb 20, 2025
43166f6
Update title's description
kin0992 Feb 20, 2025
9c343f2
Describe PR dependency and add more exaples
kin0992 Feb 20, 2025
7d529f2
Add changelog
kin0992 Feb 20, 2025
45bb016
Add example for using changeset in a monorepo
kin0992 Feb 20, 2025
373c8b2
Update description sencence
kin0992 Feb 24, 2025
8506771
Update acceptance criteria intro message
kin0992 Feb 24, 2025
d84775c
Add principles in the index page
kin0992 Feb 24, 2025
a11ed25
Update Transparency and Pragmatic Minimalism descriptions
kin0992 Feb 25, 2025
8faa043
Clarify the use of GitHub key words
kin0992 Feb 25, 2025
826d31e
Create auto merge document
kin0992 Feb 25, 2025
93d2f7c
Update pages order
kin0992 Feb 25, 2025
f4d7175
Add introduction to auto merge
kin0992 Feb 25, 2025
bd8fd22
Add benefits of auto merge feature
kin0992 Feb 25, 2025
6eb9afa
Add instruction to enable auto merge
kin0992 Feb 25, 2025
8ca70fd
Replace Terraform module link
kin0992 Feb 26, 2025
39d17f0
Update CI acceptance criteria
kin0992 Mar 5, 2025
2079afc
Add new acceptance criteria
kin0992 Mar 5, 2025
4f9fcbe
Format files
kin0992 Mar 6, 2025
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
35 changes: 35 additions & 0 deletions website/docs/conventions/pull-request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
sidebar_label: Pull Request Conventions
sidebar_position: 4
---

# Conventions for Pull Requests

## Context

Pull requests (PRs) are a critical part of the development workflow, enabling collaboration and code review.

Establishing conventions for PRs ensures clarity and consistency, making it easier for team members to understand and review changes.

## Title

The title of a pull request should be concise and meaningful, summarizing the changes made.
The title's length should not be longer than 72 characters, because GitHub truncates it.
It should not include any references to tracking systems such as Jira task IDs.

## Description

## Contribution Acceptance Criteria
To ensure that a PR can be approved, the following criteria must be met:

- Code and comments must be written in English
- A PR must contain the **smallest number of changes** possible

[//]: # (- If the pr_enrich workflow assigns the size/large label, a justification for the PR's size must be provided)
- If backward compatibility is broken, an explanation must be included
- The changes must include passing unit tests. The only exception is for tests that expose an existing bug
- The PR must be free of merge conflicts
- The PR should address only **one specific issue** or add **only one feature**. Avoid combining multiple changes; always submit separate PRs for different issues or features
- The CI pipeline must run successfully without errors

## Examples
Loading