Template clean up #10
+214
−0
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,65 @@ | ||
| name: Bug report | ||
| description: Create a report to help us improve | ||
| labels: ["bug"] | ||
| body: | ||
| - type: textarea | ||
| id: bug-description | ||
| attributes: | ||
| label: Describe the bug | ||
| description: A clear and concise description of what the bug is. | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: reproduction | ||
| attributes: | ||
| label: To Reproduce | ||
| description: "Steps to reproduce the behavior:" | ||
| placeholder: | | ||
| 1. Go to '...' | ||
| 2. Click on '....' | ||
| 3. Scroll down to '....' | ||
| 4. See error | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: expected-behavior | ||
| attributes: | ||
| label: Expected behavior | ||
| description: A clear and concise description of what you expected to happen. | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: screenshots | ||
| attributes: | ||
| label: Screenshots | ||
| description: If applicable, add screenshots to help explain your problem. | ||
| - type: textarea | ||
| id: desktop-info | ||
| attributes: | ||
| label: "Desktop (please complete the following information):" | ||
| description: | | ||
| - OS: [e.g. iOS] | ||
| - Browser [e.g. chrome, safari] | ||
| - Version [e.g. 22] | ||
| - type: textarea | ||
| id: smartphone-info | ||
| attributes: | ||
| label: "Smartphone (please complete the following information):" | ||
| description: | | ||
| - Device: [e.g. iPhone6] | ||
| - OS: [e.g. iOS8.1] | ||
| - Browser [e.g. stock browser, safari] | ||
| - Version [e.g. 22] | ||
|
Comment on lines
+37
to
+52
There was a problem hiding this comment. Do we need device info for bugs? I suspect this will not be needed for the vast majority of bug reports, make it simpler? |
||
| - type: textarea | ||
| id: context | ||
| attributes: | ||
| label: Additional context | ||
| description: Add any other context about the problem here. | ||
| - type: checkboxes | ||
| id: terms | ||
| attributes: | ||
| label: Code of Conduct | ||
| description: By submitting this issue, you agree to follow our Code of Conduct | ||
| options: | ||
| - label: I agree to follow this project's Code of Conduct | ||
| required: true | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| blank_issues_enabled: false |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,114 @@ | ||
| name: Enhancement Proposal | ||
| description: This is a template for submitting an enhancement proposal. | ||
| title: "Descriptive Title of the Enhancement" | ||
| labels: ["enhancement", "proposal"] | ||
|
|
||
| body: | ||
| - type: textarea | ||
| id: summary | ||
| attributes: | ||
| label: Summary | ||
| description: | | ||
| A 1-2 paragraph "elevator pitch" of the enhancement. It should be understandable to someone familiar with UCP but not necessarily the deep technical details of this specific proposal. | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: motivation | ||
| attributes: | ||
| label: Motivation | ||
| description: | | ||
| Explain the problem this proposal solves. Why is this significant change necessary now? What use cases does it enable? Who is the target user or beneficiary of this change? | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: goals | ||
| attributes: | ||
| label: Goals | ||
| description: | | ||
| List the specific, measurable outcomes of this enhancement. | ||
| placeholder: | | ||
| * | ||
| * | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: non-goals | ||
| attributes: | ||
| label: Non-Goals | ||
| description: | | ||
| Explicitly state what is out of scope for this proposal. This helps focus the discussion and prevents scope creep. | ||
| placeholder: | | ||
| * | ||
| * | ||
| - type: textarea | ||
| id: detailed-design | ||
| attributes: | ||
| label: Detailed Design | ||
| description: | | ||
| This is the core of the proposal. Describe the architecture and implementation details with enough clarity that another contributor could write the code based on this description. Include sub-sections as needed, such as: | ||
|
|
||
| * **API Changes:** Detail any new API endpoints, changes to existing ones, or modifications to request/response schemas. | ||
| * **Data Structures:** Describe any changes to core data structures or JSON schemas. | ||
| * **Behavioral Changes:** Explain how the system's fundamental behavior will change. | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: risks-mitigations | ||
| attributes: | ||
| label: Risks and Mitigations | ||
| description: | | ||
| This is a mandatory section. Discuss the potential downsides and risks of this proposal. For every risk identified, list a mitigation strategy. | ||
|
|
||
| * **Security:** Does this introduce new attack vectors or data exposure risks? | ||
| * **Performance:** Will this negatively impact latency or throughput? | ||
| * **Backward Compatibility:** Will this break existing clients or workflows? If so, what is the migration plan? | ||
| * **Complexity:** Does this add significant maintenance burden to the protocol? | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: test-plan | ||
| attributes: | ||
| label: Test Plan | ||
| description: | | ||
| Describe how this feature will be tested. A test plan is required for a proposal to be moved to the "Provisional" stage. | ||
|
|
||
| * **Unit Tests:** Which core logic requires unit coverage? | ||
| * **Integration Tests:** How will interactions between different components be verified? | ||
| * **End-to-End Tests:** What user scenarios will be automated to validate the full workflow? | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: graduation-criteria | ||
| attributes: | ||
| label: Graduation Criteria | ||
| description: | | ||
| Define the specific, objective criteria required to move this capability through the maturity levels. See CONTRIBUTING.md for full definitions of each level. | ||
| value: | | ||
| **Working Draft → Candidate:** | ||
| * [ ] Schema merged and documented (with Working Draft disclaimer). | ||
| * [ ] Unit and integration tests are passing. | ||
| * [ ] Initial documentation is written. | ||
| * [ ] TC majority vote to advance. | ||
|
|
||
| **Candidate → Stable:** | ||
| * [ ] Adoption feedback has been collected and addressed. | ||
| * [ ] Full documentation and migration guides are published. | ||
| * [ ] TC majority vote to advance. | ||
| - type: textarea | ||
| id: implementation-history | ||
| attributes: | ||
| label: Implementation History | ||
| description: | | ||
| This section will be updated by the maintainers as the proposal moves through its lifecycle. | ||
| value: | | ||
| * [YYYY-MM-DD]: Proposal submitted. | ||
| * [YYYY-MM-DD]: TC approved "Provisional"; capability enters "Working Draft". | ||
| * [YYYY-MM-DD]: TC approved advancement to "Candidate". | ||
| * [YYYY-MM-DD]: TC approved "Implemented"; capability enters "Stable". | ||
| - type: checkboxes | ||
| id: terms | ||
| attributes: | ||
| label: Code of Conduct | ||
| description: By submitting this issue, you agree to follow our Code of Conduct | ||
| options: | ||
| - label: I agree to follow this project's Code of Conduct | ||
| required: true | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| name: Feature request | ||
|
There was a problem hiding this comment. Aren't you missing a title? https://github.com/Universal-Commerce-Protocol/ucp/blob/main/.github/ISSUE_TEMPLATE/feature-request.yml?plain=1 |
||
| description: Suggest an idea for this project | ||
| body: | ||
| - type: textarea | ||
| id: problem | ||
| attributes: | ||
| label: Is your feature request related to a problem? Please describe. | ||
| description: A clear and concise description of what the problem is. | ||
| placeholder: Ex. I'm always frustrated when [...] | ||
| - type: textarea | ||
| id: describe | ||
| attributes: | ||
| label: Describe the solution you'd like | ||
| description: A clear and concise description of what you want to happen. | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: alternatives | ||
| attributes: | ||
| label: Describe alternatives you've considered | ||
| description: A clear and concise description of any alternative solutions or features you've considered. | ||
| - type: textarea | ||
| id: context | ||
| attributes: | ||
| label: Additional context | ||
| description: Add any other context or screenshots about the feature request here. | ||
| - type: checkboxes | ||
| id: terms | ||
| attributes: | ||
| label: Code of Conduct | ||
| description: By submitting this issue, you agree to follow our Code of Conduct | ||
| options: | ||
| - label: I agree to follow this project's Code of Conduct | ||
| required: true | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Aren't you missing a title? https://github.com/Universal-Commerce-Protocol/ucp/blob/main/.github/ISSUE_TEMPLATE/bug-report.yml?plain=1