Skip to content

Docs: complete cut-off sentence in “Preparing a pull request” section #3721

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
wants to merge 2 commits into
base: develop
Choose a base branch
from
Open

Docs: complete cut-off sentence in “Preparing a pull request” section #3721

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
487ad98
Docs: complete cut-off sentence in 'Preparing a pull request' section
sdass1918 Nov 10, 2025
3cdbfb8
Merge branch 'develop' into fix-docs-pr-template
sdass1918 Nov 10, 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
12 changes: 11 additions & 1 deletion contributor_docs/preparing_a_pull_request.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,17 @@ Then ask git about the latest changes.
git status

## Pull Request Templates
Once you've opened your pull request, please ensure that you follow the guidelines.

Once you've opened your pull request, please ensure that you follow the guidelines **and verify the following before submitting for review:**

- ✅ Your code has no linting errors (`npm run lint`)
- ✅ All tests pass successfully (`npm run test`)
- ✅ Your branch name is unique and based off the latest `develop` branch
- ✅ The pull request title and description clearly describe the change
- ✅ Your pull request links to the related issue number (e.g., `Fixes #1234`)
- ✅ Screenshots or videos are included if the change affects the user interface

Following these steps helps maintain code quality and makes it easier for maintainers to review and merge your contribution.

## CONFLICTS
You may have some conflicts! It's okay. Feel free to ask for help. If merging with the latest upstream `develop` branch causes conflicts, you can always make a pull request with the upstream repository, which makes the merge conflicts public.
Expand Down