mirror of
https://github.com/documenso/documenso.git
synced 2025-11-13 00:03:33 +10:00
chore: add issue and pr templates
This commit is contained in:
50
.github/ISSUE_TEMPLATE/bug-report.md
vendored
Normal file
50
.github/ISSUE_TEMPLATE/bug-report.md
vendored
Normal file
@ -0,0 +1,50 @@
|
||||
---
|
||||
name: Bug Report
|
||||
about: Create a bug report to help us improve
|
||||
---
|
||||
|
||||
<!--- Please provide a general summary of the issue in the Title above -->
|
||||
|
||||
## Issue Description
|
||||
|
||||
<!--- Please provide a clear and concise description of the problem. -->
|
||||
|
||||
## Steps to Reproduce
|
||||
|
||||
<!--- Please provide step-by-step instructions to reproduce the issue. -->
|
||||
<!--- Include code snippets, error messages, and any other relevant information. -->
|
||||
|
||||
1. Step 1
|
||||
2. Step 2
|
||||
3. ...
|
||||
|
||||
## Expected Behavior
|
||||
|
||||
<!--- Describe what you expected to happen. -->
|
||||
|
||||
## Current Behavior
|
||||
|
||||
<!--- Describe what is currently happening. -->
|
||||
|
||||
## Screenshots (optional)
|
||||
|
||||
<!--- If applicable, add screenshots to help explain the issue. -->
|
||||
|
||||
## Environment
|
||||
|
||||
<!--- Please provide information about your environment, such as operating system, browser, version, etc. -->
|
||||
|
||||
- OS: [e.g., Windows 10]
|
||||
- Browser: [e.g., Chrome, Firefox]
|
||||
- Version: [e.g., 2.0.1]
|
||||
|
||||
## Checklist
|
||||
|
||||
<!--- Please check the boxes that apply to this issue report. -->
|
||||
<!--- You can add or remove items as needed. -->
|
||||
|
||||
- [ ] I have searched the existing issues to make sure this is not a duplicate.
|
||||
- [ ] I have provided steps to reproduce the issue.
|
||||
- [ ] I have included relevant environment information.
|
||||
- [ ] I have included any relevant screenshots.
|
||||
- [ ] I understand that this is a voluntary contribution and that there is no guarantee of resolution.
|
||||
41
.github/ISSUE_TEMPLATE/feature-request.md
vendored
Normal file
41
.github/ISSUE_TEMPLATE/feature-request.md
vendored
Normal file
@ -0,0 +1,41 @@
|
||||
---
|
||||
name: Feature Request
|
||||
about: Suggest a new idea or enhancement for this project
|
||||
---
|
||||
|
||||
<!--- Please provide a clear and concise title for your feature request -->
|
||||
|
||||
## Feature Description
|
||||
|
||||
<!--- Describe the feature you are requesting in detail. -->
|
||||
<!--- Explain what problem it solves or what value it adds to the project. -->
|
||||
|
||||
## Use Case
|
||||
|
||||
<!--- Provide a scenario or use case where this feature would be beneficial. -->
|
||||
<!--- Explain how users would interact with this feature and why it's important. -->
|
||||
|
||||
## Proposed Solution
|
||||
|
||||
<!--- If you have an idea of how this feature could be implemented, describe it here. -->
|
||||
<!--- Include any technical details, UI/UX considerations, or design suggestions. -->
|
||||
|
||||
## Alternatives (optional)
|
||||
|
||||
<!--- Are there any alternative ways to achieve the same goal? -->
|
||||
<!--- Describe other approaches that could be considered if this feature is not implemented. -->
|
||||
|
||||
## Additional Context
|
||||
|
||||
<!--- Add any additional context or information that might be relevant to the feature request. -->
|
||||
|
||||
## Checklist
|
||||
|
||||
<!--- Please check the boxes that apply to this feature request. -->
|
||||
<!--- You can add or remove items as needed. -->
|
||||
|
||||
- [ ] I have searched the existing feature requests to make sure this is not a duplicate.
|
||||
- [ ] I have provided a detailed description of the requested feature.
|
||||
- [ ] I have explained the use case or scenario for this feature.
|
||||
- [ ] I have included any relevant technical details or design suggestions.
|
||||
- [ ] I understand that this is a suggestion and that there is no guarantee of implementation.
|
||||
41
.github/ISSUE_TEMPLATE/improvement.md
vendored
Normal file
41
.github/ISSUE_TEMPLATE/improvement.md
vendored
Normal file
@ -0,0 +1,41 @@
|
||||
---
|
||||
name: General Improvement
|
||||
about: Suggest a minor enhancement or improvement for this project
|
||||
---
|
||||
|
||||
<!--- Please provide a clear and concise title for your improvement suggestion -->
|
||||
|
||||
## Improvement Description
|
||||
|
||||
<!--- Describe the improvement you are suggesting in detail. -->
|
||||
<!--- Explain what specific aspect of the project it addresses or enhances. -->
|
||||
|
||||
## Rationale
|
||||
|
||||
<!--- Explain why this improvement would be beneficial. -->
|
||||
<!--- Share any context, pain points, or reasons for suggesting this change. -->
|
||||
|
||||
## Proposed Solution
|
||||
|
||||
<!--- If you have a suggestion for how this improvement could be implemented, describe it here. -->
|
||||
<!--- Include any technical details, design suggestions, or other relevant information. -->
|
||||
|
||||
## Alternatives (optional)
|
||||
|
||||
<!--- Are there any alternative approaches to achieve the same improvement? -->
|
||||
<!--- Describe other ways to address the issue or enhance the project. -->
|
||||
|
||||
## Additional Context
|
||||
|
||||
<!--- Add any additional context or information that might be relevant to the improvement suggestion. -->
|
||||
|
||||
## Checklist
|
||||
|
||||
<!--- Please check the boxes that apply to this improvement suggestion. -->
|
||||
<!--- You can add or remove items as needed. -->
|
||||
|
||||
- [ ] I have searched the existing issues and improvement suggestions to avoid duplication.
|
||||
- [ ] I have provided a clear description of the improvement being suggested.
|
||||
- [ ] I have explained the rationale behind this improvement.
|
||||
- [ ] I have included any relevant technical details or design suggestions.
|
||||
- [ ] I understand that this is a suggestion and that there is no guarantee of implementation.
|
||||
49
.github/PULL_REQUEST_TEMPLATE/generic.md
vendored
Normal file
49
.github/PULL_REQUEST_TEMPLATE/generic.md
vendored
Normal file
@ -0,0 +1,49 @@
|
||||
---
|
||||
name: Pull Request
|
||||
about: Submit changes to the project for review and inclusion
|
||||
---
|
||||
|
||||
## Description
|
||||
|
||||
<!--- Describe the changes introduced by this pull request. -->
|
||||
<!--- Explain what problem it solves or what feature/fix it adds. -->
|
||||
|
||||
## Related Issue
|
||||
|
||||
<!--- If this pull request is related to a specific issue, reference it here using #issue_number. -->
|
||||
<!--- For example, "Fixes #123" or "Addresses #456". -->
|
||||
|
||||
## Changes Made
|
||||
|
||||
<!--- Provide a summary of the changes made in this pull request. -->
|
||||
<!--- Include any relevant technical details or architecture changes. -->
|
||||
|
||||
- Change 1
|
||||
- Change 2
|
||||
- ...
|
||||
|
||||
## Testing Performed
|
||||
|
||||
<!--- Describe the testing that you have performed to validate these changes. -->
|
||||
<!--- Include information about test cases, testing environments, and results. -->
|
||||
|
||||
- Tested feature X in scenario Y.
|
||||
- Ran unit tests for component Z.
|
||||
- Tested on browsers A, B, and C.
|
||||
- ...
|
||||
|
||||
## Checklist
|
||||
|
||||
<!--- Please check the boxes that apply to this pull request. -->
|
||||
<!--- You can add or remove items as needed. -->
|
||||
|
||||
- [ ] I have tested these changes locally and they work as expected.
|
||||
- [ ] I have added/updated tests that prove the effectiveness of these changes.
|
||||
- [ ] I have updated the documentation to reflect these changes, if applicable.
|
||||
- [ ] I have followed the project's coding style guidelines.
|
||||
- [ ] I have addressed the code review feedback from the previous submission, if applicable.
|
||||
|
||||
## Additional Notes
|
||||
|
||||
<!--- Provide any additional context or notes for the reviewers. -->
|
||||
<!--- This might include details about design decisions, potential concerns, or anything else relevant. -->
|
||||
40
.github/PULL_REQUEST_TEMPLATE/test-addition.md
vendored
Normal file
40
.github/PULL_REQUEST_TEMPLATE/test-addition.md
vendored
Normal file
@ -0,0 +1,40 @@
|
||||
---
|
||||
name: Test Addition
|
||||
about: Submit a new test, either unit or end-to-end (E2E), for review and inclusion
|
||||
---
|
||||
|
||||
## Description
|
||||
|
||||
<!--- Provide a clear and concise description of the new test you are adding. -->
|
||||
<!--- Explain the purpose of the test and what it aims to validate. -->
|
||||
|
||||
## Related Issue
|
||||
|
||||
<!--- If this test addition is related to a specific issue, reference it here using #issue_number. -->
|
||||
<!--- For example, "Fixes #123" or "Addresses #456". -->
|
||||
|
||||
## Test Details
|
||||
|
||||
<!--- Describe the details of the test you're adding. -->
|
||||
<!--- Include information about inputs, expected outputs, and any specific scenarios. -->
|
||||
|
||||
- Test Name: Name of the test
|
||||
- Type: [Unit / E2E]
|
||||
- Description: Brief description of what the test checks
|
||||
- Inputs: What inputs the test uses (if applicable)
|
||||
- Expected Output: What output or behavior the test expects
|
||||
|
||||
## Checklist
|
||||
|
||||
<!--- Please check the boxes that apply to this pull request. -->
|
||||
<!--- You can add or remove items as needed. -->
|
||||
|
||||
- [ ] I have written the new test and ensured it works as intended.
|
||||
- [ ] I have added necessary documentation to explain the purpose of the test.
|
||||
- [ ] I have followed the project's testing guidelines and coding style.
|
||||
- [ ] I have addressed any review feedback from previous submissions, if applicable.
|
||||
|
||||
## Additional Notes
|
||||
|
||||
<!--- Provide any additional context or notes for the reviewers. -->
|
||||
<!--- This might include explanations about the testing approach or any potential concerns. -->
|
||||
Reference in New Issue
Block a user