diff --git a/.github/ISSUE_TEMPLATE/Bug_Report.yml b/.github/ISSUE_TEMPLATE/Bug_Report.yml index 596db398e41..33999ee6341 100644 --- a/.github/ISSUE_TEMPLATE/Bug_Report.yml +++ b/.github/ISSUE_TEMPLATE/Bug_Report.yml @@ -25,10 +25,28 @@ body: attributes: label: 😯 Current Behavior description: | - Tell us what happens instead of the expected behavior. Please include a link to our docs, our storybook, or a StackBlitz reproduction if possible. + Tell us what happens instead of the expected behavior. If you are seeing an error, please include the full error message and stack trace. validations: required: true + - type: input + id: stackblitz-link + attributes: + label: StackBlitz Reproduction + description: | + Share a link to a minimal StackBlitz project that reproduces the issue. Include only the code needed to demonstrate the problem. + + To get started, open an example in our docs and choose “Open in StackBlitz” from the menu next to the example. Fork and save your project before sharing the link. If you cannot provide a StackBlitz reproduction, explain why. + validations: + required: true + - type: textarea + id: base-reproduction + attributes: + label: 🖥️ Steps to Reproduce + description: | + List the exact steps needed to trigger the issue in your example. + validations: + required: true - type: textarea id: possible-solution attributes: @@ -45,25 +63,17 @@ body: How has this issue affected you? What are you trying to accomplish? validations: required: true - - type: textarea - id: base-reproduction - attributes: - label: 🖥️ Steps to Reproduce - description: | - Provide a minimal test case that can reproduce the problem. Include a StackBlitz, link to sample repos, or specific doc examples to help us test your issue more easily. - - To get a StackBlitz template, go to an example in the docs and select the "Open in StackBlitz" option in the menu next to the example. - Be sure to fork/save the StackBlitz project before sharing the link. - validations: - required: true - type: markdown attributes: value: '## 🌍 Your Environment' - - type: input + - type: textarea id: version attributes: label: Version - description: What version of react-spectrum are you running? + description: List the affected packages(s) and the exact install version of each. + placeholder: | + react-aria-components@ + @react-spectrum/s2@ validations: required: true - type: dropdown diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index f8eb6c9f262..1c49ac6d1cf 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,21 +1,37 @@ - + Closes -## ✅ Pull Request Checklist: +## Summary -- [ ] Included link to corresponding [React Spectrum GitHub Issue](https://github.com/adobe/react-spectrum/issues). -- [ ] Added/updated unit tests and storybook for this change (for new code or code which already has tests). -- [ ] Filled out test instructions. -- [ ] Updated documentation (if it already exists for this component). -- [ ] Looked at the Accessibility Practices for this feature - [Aria Practices](https://www.w3.org/WAI/ARIA/apg/) -- [ ] I understand every change in this PR and can explain why it's there. -- [ ] If AI-assisted, I followed our [AI contribution guidance](https://github.com/adobe/react-spectrum/blob/main/CONTRIBUTING.md#ai-assisted-contributions) and pointed my assistant at [AGENTS.md](https://github.com/adobe/react-spectrum/blob/main/AGENTS.md). + -## 📝 Test Instructions: +## 📝 Test Instructions - + -## 🧢 Your Project: +## Release impact - + + +- [ ] Only changes docs, tests, CI, or development tools. Nothing shipped to users changes. +- [ ] Fixes a bug or improves existing code without changing how apps use it. +- [ ] Adds a feature or API while keeping existing usage working. +- [ ] May break existing usage or require changes in apps that use this code. + +## ✅ PR Checklist + +- [ ] I followed the [contributing guide](https://github.com/adobe/react-spectrum/blob/main/CONTRIBUTING.md). +- [ ] I tested this change locally and included the results in Test Instructions, or explained why testing does not apply. +- [ ] I understand and can explain every change in this PR. If I used AI assistance, I followed the [AI contribution guidance](https://github.com/adobe/react-spectrum/blob/main/CONTRIBUTING.md#ai-assisted-contributions). + +## 🧢 Your Project + + diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c1b9ad91aa7..3fc4026f89f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -27,7 +27,7 @@ For significant changes, it is recommended that you first propose your solution A few things to keep in mind before submitting a pull request: -- Add a clear description covering your changes +- Add a clear description covering your changes. See [describing the problem](#describing-the-problem) - Reference the issue in the description - Make sure linting and tests pass - Include relevant unit tests @@ -44,6 +44,26 @@ Read [GitHub's pull request documentation](https://help.github.com/articles/abou Lastly, please follow the pull request template when submitting a pull request! +### Describing the problem + +Whether you open an issue or a PR, provide enough context for us to understand the problem and assess the proposed change. + +If an issue already exists, link it and read the discussion. You do not need to copy information that is already there, but include any new findings or changes to the proposed approach. + +If there is no issue, include the information requested by the relevant[bug report](.github/ISSUE_TEMPLATE/Bug_Report.yml) or [feature request](.github/ISSUE_TEMPLATE/Feature_Request.yml) template in your PR description. + +For bug fixes, include: + +- What happens and what you expected to happen. +- What you are trying to accomplish and how the bug affects you. +- Reproduction steps and a minimal example we can use to verify the problem. +- The affected package version, browser, and operating system. + +For features, explain the current limitation, the concrete use case, and how the proposed behavior would help. Include examples where useful. + +Documentation and routine maintenance changes should explain their purpose; they do not need an artificial bug report or reproduction. + +Search existing issues and PRs before opening either, and link related work when you find it. A PR can also be the starting point for a design discussion; opening it does not mean the proposed scope or approach has been approved. ## AI-assisted contributions Setting expectations: the AI doesn't contribute to React Spectrum, you do. The AI is a tool, but you are still the author, and you own every line, every decision, and every explanation.