Skip to content

docs: improve contributing and pull request documentation #5387

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

Merged
merged 28 commits into from
May 5, 2025

Conversation

caseyisonit
Copy link
Contributor

@caseyisonit caseyisonit commented Apr 22, 2025

Description

This PR introduces:

  • a PULL_REQUESTS.md file that outlines our PR submission and review process. It also includes etiquette guidelines and conflict resolution notes.
  • improvements to our CONTRIBUTING.md file to clean up the structure and provide more clarity for contributors to our process.
  • PR template cleanup to reduce redundancy in completing it

The goal of this PR is to be COLLABORATIVE. Nothing is set in stone and is absolutely up for discussion and amendment. All reviewers are encouraged to add comments and questions to have discussion.

Related issue(s)

  • SWC-764

How has this been tested?

  • Read Contributing doc

  • Read Pull requests doc

Checklist

  • If my change required a change to the documentation, I have updated the documentation in this pull request.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • I have reviewed at the Accessibility Practices for this feature, see: Aria Practices

Best practices

This repository uses conventional commit syntax for each commit message; note that the GitHub UI does not use this by default so be cautious when accepting suggested changes. Avoid the "Update branch" button on the pull request and opt instead for rebasing your branch against main.

@caseyisonit caseyisonit requested a review from a team as a code owner April 22, 2025 18:15
Copy link

changeset-bot bot commented Apr 22, 2025

⚠️ No Changeset found

Latest commit: 3fbd28a

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link

Branch preview

Review the following VRT differences

When a visual regression test fails (or has previously failed while working on this branch), its results can be found in the following URLs:

If the changes are expected, update the current_golden_images_cache hash in the circleci config to accept the new images. Instructions are included in that file.
If the changes are unexpected, you can investigate the cause of the differences and update the code accordingly.

Copy link

Tachometer results

Currently, no packages are changed by this PR...

Copy link
Collaborator

@najikahalsema najikahalsema left a comment

Choose a reason for hiding this comment

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

This looks great so far! I have one request but otherwise thank you so much for your work on this!

Copy link
Collaborator

@pfulton pfulton left a comment

Choose a reason for hiding this comment

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

Overall, I think this looks good. I just noticed a few things that I wanted to suggest! I'm fine with merging, but will reserve an approval until others are able to review, too.

Copy link
Collaborator

@najikahalsema najikahalsema left a comment

Choose a reason for hiding this comment

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

My pass has... passed. Take a look!

Copy link
Contributor

@Rajdeepc Rajdeepc left a comment

Choose a reason for hiding this comment

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

Good start! Thank you for doing this!

Copy link
Collaborator

@najikahalsema najikahalsema left a comment

Choose a reason for hiding this comment

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

Looks GREAT! One little nit, not a blocker, but while i love the emojis in the sev classification table, they also do put the numbers on a newline 😭

I just thought you'd like to know since i wasn't originally reading this outside of the diff.

image

Copy link
Contributor

@nikkimk nikkimk left a comment

Choose a reason for hiding this comment

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

LGTM (Lofty Goal Totally Met)

@caseyisonit caseyisonit enabled auto-merge (squash) May 5, 2025 17:44
@caseyisonit caseyisonit merged commit 950b5fa into main May 5, 2025
24 checks passed
@caseyisonit caseyisonit deleted the caseyisonit/docs-improvement branch May 5, 2025 18:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants