Making a Pull Request

A pull request (often shortened to PR) asks the maintainers to review your changes and merge them into the project. A branch is a separate line of work that keeps your change away from the published site until it is approved.

Before starting, complete the relevant items in the Contributing Checklist.

Choose your contribution method

If you are an external contributor

Volunteers normally work from a personal copy of the repository called a fork.

1. Open the PWindows Website repository on GitHub.
2. Select Fork, then create the fork under your GitHub account.
3. In your fork, create a branch with a short name, such as fix-contact-text.
4. Make and test your changes on that branch.
5. Commit the files and push the branch to your fork.
6. Open your fork on GitHub and select Contribute → Open pull request.
7. Check that the base repository is PWindows/Website.
8. Write a clear title and explain what changed, why it changed, and how you tested it.
9. Fill in the pull request template.
10. Submit the pull request and wait for the automated checks and a maintainer review.

If you are a maintainer with write access

You do not need a fork, but you should still use a separate branch:

git switch -c short-description

Make and test the change, commit it, and push the branch:

git push -u origin short-description

Then open the repository on GitHub and create a pull request from that branch. Automated checks run when the pull request is opened or updated. Run the relevant local checks first so reviewers do not have to wait for easily preventable failures.

Prepare the pull request

Write a useful description

Include:

• a short explanation of the problem;
• a summary of the solution;
• the pages or features affected;
• the devices and browser sizes you tested;
• screenshots for visible design changes;
• links to related issues if needed

Complete the repository's pull request template if one appears. Add labels only if you have permission and know which labels apply; otherwise a maintainer can add them.

After submitting

Respond to review

If a reviewer requests changes:

1. Ask for clarification if you do not understand the request.
2. Make the change on the same branch.
3. Test it again, commit it, and push it. The existing pull request updates automatically.
4. Reply to the review and request another look when the work is ready.
5. Let the reviewer resolve review conversations unless they ask you to do so.

Congratulations 🎉!

When the pull request is approved and all checks pass, a maintainer can merge it. Thank you for contributing :D

Return to Home.