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
Merged
Show file tree
Hide file tree
Changes from 11 commits
Commits
Show all changes
28 commits
Select commit Hold shift + click to select a range
71b5064
docs: updating contributing and starting PR review doc
caseyisonit Apr 8, 2025
5a7b36a
chore: pr doc start
caseyisonit Apr 10, 2025
848e17c
chore: pr doc working
caseyisonit Apr 11, 2025
7acec04
Merge branch 'main' into caseyisonit/docs-improvement
caseyisonit Apr 21, 2025
9beb611
chore: minor update to pr doc
caseyisonit Apr 22, 2025
30b71d3
Merge branch 'main' into caseyisonit/docs-improvement
caseyisonit Apr 22, 2025
0a5a7c0
chore: clean up pr template
caseyisonit Apr 22, 2025
b853df1
add github keywords link
caseyisonit Apr 22, 2025
0d06456
link to readme
caseyisonit Apr 22, 2025
125f5d7
bullet
caseyisonit Apr 22, 2025
a7f3a48
convention commits link
caseyisonit Apr 22, 2025
9aea9ed
update contributing heading
caseyisonit Apr 23, 2025
d57dd1c
Merge branch 'main' into caseyisonit/docs-improvement
caseyisonit Apr 23, 2025
944ad8e
docs: update community and support section
caseyisonit Apr 23, 2025
e7f69e0
Update documentation checkbox list item
caseyisonit Apr 28, 2025
220ce4d
Update accessibility section intro
caseyisonit Apr 28, 2025
5202967
Merge branch 'main' into caseyisonit/docs-improvement
caseyisonit Apr 30, 2025
ea79544
chore: addressing feedback
caseyisonit Apr 30, 2025
a103f85
Apply suggestions from code review
caseyisonit Apr 30, 2025
5950185
chore: address feedback
caseyisonit Apr 30, 2025
3518787
chore: address feedback
caseyisonit Apr 30, 2025
733a353
Merge branch 'main' into caseyisonit/docs-improvement
caseyisonit Apr 30, 2025
51f34a6
chore: address feedback
caseyisonit May 1, 2025
63825c4
Apply suggestions from code review
caseyisonit May 5, 2025
c0eeaf6
Merge branch 'main' into caseyisonit/docs-improvement
caseyisonit May 5, 2025
f81cfb7
chore: final pass
caseyisonit May 5, 2025
c21d416
Merge branch 'main' into caseyisonit/docs-improvement
caseyisonit May 5, 2025
3fbd28a
chore: disable azure check while its being worked on
caseyisonit May 5, 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
41 changes: 15 additions & 26 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
<!--- Provide a general summary of your changes in the Title above -->
<!--- PR titles should follow conventional commit and should include commit type as defined in in the PULL_REQUESTS guide -->

## Description

Expand All @@ -7,57 +8,45 @@
## Related issue(s)

<!---
This project only accepts pull requests related to open issues

- If suggesting a new feature or change, please discuss it in an issue first.
- If fixing a bug, there should be an issue describing it with steps to reproduce.
- If you're Adobe internal, add a Jira ticket number but do NOT link directly to Jira.
-->

-

## Motivation and context

<!--- Why is this change required? What problem does it solve? -->
- fixes [Issue Number]

## How has this been tested?

<!--- Please describe in detail how you tested your changes. -->
Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe a nice to-do would be to link to a doc outlining how to write test cases and requirements for PR validation?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

i can make a follow up ticket for this

<!--- Include details of your testing environment, and the tests you ran to see how your change affects other areas of the code, etc. -->

- [ ] _Test case 1_
- [ ] _Descriptive Test Statement_

1. Go here
2. Do this
- [ ] _Test case 2_
3. Expect this

- [ ] _Descriptive Test Statement_
1. Go here
2. Do this
3. Expect this

Polypane review:

- [ ] Did it pass in Desktop?
- [ ] Did it pass in Mobile?
- [ ] Did it pass in iPad?
- [ ] Did it pass in (emulated) Mobile?
- [ ] Did it pass in (emulated) iPad?

## Screenshots (if appropriate)

## Types of changes

<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->

- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to change)
- [ ] Chore (minor updates related to the tooling or maintenance of the repository, does not impact compiled assets)

## Checklist

<!--- Go over all the following points, and put an `x` in all the boxes that apply. If you're unsure about any of these, don't hesitate to ask. We're here to help! -->

- [ ] I have signed the [Adobe Open Source CLA](http://opensource.adobe.com/cla.html).
- [ ] My code follows the code style of this project.
- [ ] If my change required a change to the documentation, I have updated the documentation in this pull request.
- [ ] I have read the **[CONTRIBUTING](<(https://github.com/adobe/spectrum-web-components/blob/main/CONTRIBUTING.md)>)** document.
- [ ] I have added tests to cover my changes.
- [ ] All new and existing tests passed.
- [ ] I have read the **[CONTRIBUTING](<(https://github.com/adobe/spectrum-web-components/blob/main/CONTRIBUTING.md)>)** and **[PULL_REQUESTS](<(https://github.com/adobe/spectrum-web-components/blob/main/PULL_REQUESTS.md)>)** documents.
- [ ] I have reviewed at the Accessibility Practices for this feature, see: [Aria Practices](https://www.w3.org/TR/wai-aria-practices/)
- [ ] I have added tests to cover my changes.
- [ ] I have ensured documentation covers my changes.

## Best practices

Expand Down
Loading
Loading