-
-
Notifications
You must be signed in to change notification settings - Fork 1.7k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
cbcb1ae
commit 781f71a
Showing
4 changed files
with
173 additions
and
0 deletions.
There are no files selected for viewing
This file contains 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,74 @@ | ||
| name: "📝 Feature Proposal for v3" | ||
| title: "📝 [v3 Proposal]: " | ||
| description: Propose a feature or improvement for Fiber v3. | ||
| labels: ["📝 Proposal", "v3"] | ||
|
|
||
| body: | ||
| - type: markdown | ||
| id: notice | ||
| attributes: | ||
| value: | | ||
| ### Notice | ||
| - For questions, join our [Discord server](https://gofiber.io/discord). | ||
| - Please write in clear, understandable English. | ||
| - Ensure your proposal aligns with Express design principles and HTTP RFC standards. | ||
| - Describe features expected to remain stable and not require changes in the foreseeable future. | ||
| - type: textarea | ||
| id: description | ||
| attributes: | ||
| label: "Feature Proposal Description" | ||
| description: "A clear and detailed description of the feature you are proposing for Fiber v3. How should it work, and what API endpoints and methods would it involve?" | ||
| placeholder: "Describe your feature proposal clearly and in detail, including API endpoints and methods." | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| id: express-alignment | ||
| attributes: | ||
| label: "Alignment with Express API" | ||
| description: "Explain how your proposal aligns with the design and API of Express.js. Provide comparative examples if possible." | ||
| placeholder: "Outline how the feature aligns with Express.js design principles and API standards." | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| id: standards-compliance | ||
| attributes: | ||
| label: "HTTP RFC Standards Compliance" | ||
| description: "Confirm that the feature complies with HTTP RFC standards, and describe any relevant aspects." | ||
| placeholder: "Detail how the feature adheres to HTTP RFC standards." | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| id: stability | ||
| attributes: | ||
| label: "API Stability" | ||
| description: "Discuss the expected stability of the feature and its API. How do you ensure that it will not require changes or deprecations in the near future?" | ||
| placeholder: "Describe measures taken to ensure the feature's API stability over time." | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| id: examples | ||
| attributes: | ||
| label: "Feature Examples" | ||
| description: "Provide concrete examples and code snippets to illustrate how the proposed feature should function." | ||
| placeholder: "Share code snippets that exemplify the proposed feature and its usage." | ||
| render: go | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: checkboxes | ||
| id: terms | ||
| attributes: | ||
| label: "Checklist:" | ||
| description: "By submitting this issue, you confirm that:" | ||
| options: | ||
| - label: "I agree to follow Fiber's [Code of Conduct](https://github.com/gofiber/fiber/blob/master/.github/CODE_OF_CONDUCT.md)." | ||
| required: true | ||
| - label: "I have searched for existing issues that describe my proposal before opening this one." | ||
| required: true | ||
| - label: "I understand that a proposal that does not meet these guidelines may be closed without explanation." | ||
| required: true |
This file contains 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,54 @@ | ||
| name: "🧹 v3 Maintenance Task" | ||
| title: "🧹 [v3 Maintenance]: " | ||
| description: Describe a maintenance task for the v3 of the Fiber project. | ||
| labels: ["🧹 Updates", "v3"] | ||
|
|
||
| body: | ||
| - type: markdown | ||
| id: notice | ||
| attributes: | ||
| value: | | ||
| ### Notice | ||
| - Before submitting a maintenance task, please check if a similar task has already been filed. | ||
| - Clearly outline the purpose of the maintenance task and its impact on the project. | ||
| - Use clear and understandable English. | ||
| - type: textarea | ||
| id: task-description | ||
| attributes: | ||
| label: "Maintenance Task Description" | ||
| description: "Provide a detailed description of the maintenance task. Include any specific areas of the codebase that require attention, and the desired outcomes of this task." | ||
| placeholder: "Detail the maintenance task, specifying what needs to be done and why it is necessary." | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| id: impact | ||
| attributes: | ||
| label: "Impact on the Project" | ||
| description: "Explain the impact this maintenance will have on the project. Include benefits and potential risks if applicable." | ||
| placeholder: "Describe how completing this task will benefit the project, or the risks of not addressing it." | ||
| validations: | ||
| required: false | ||
|
|
||
| - type: textarea | ||
| id: additional-context | ||
| attributes: | ||
| label: "Additional Context (optional)" | ||
| description: "Any additional information or context regarding the maintenance task that might be helpful." | ||
| placeholder: "Provide any additional information that may be relevant to the task at hand." | ||
| validations: | ||
| required: false | ||
|
|
||
| - type: checkboxes | ||
| id: terms | ||
| attributes: | ||
| label: "Checklist:" | ||
| description: "Please confirm the following:" | ||
| options: | ||
| - label: "I have confirmed that this maintenance task is currently not being addressed." | ||
| required: true | ||
| - label: "I understand that this task will be evaluated by the maintainers and prioritized accordingly." | ||
| required: true | ||
| - label: "I am available to provide further information if needed." | ||
| required: true |
File renamed without changes.
This file contains 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,45 @@ | ||
| ## Description | ||
|
|
||
| Please provide a clear and concise description of the changes you've made and the problem they address. Include the purpose of the change, any relevant issues it solves, and the benefits it brings to the project. If this change introduces new features or adjustments, highlight them here. | ||
|
|
||
| Related to # (issue) | ||
|
|
||
| ## Changes Introduced | ||
|
|
||
| List the new features or adjustments introduced in this pull request. Provide details on benchmarks, documentation updates, changelog entries, and if applicable, the migration guide. | ||
|
|
||
| - [ ] Benchmarks: Describe any performance benchmarks and improvements related to the changes. | ||
| - [ ] Documentation Update: Detail the updates made to the documentation and links to the changed files. | ||
| - [ ] Changelog/What's New: Include a summary of the additions for the upcoming release notes. | ||
| - [ ] Migration Guide: If necessary, provide a guide or steps for users to migrate their existing code to accommodate these changes. | ||
| - [ ] API Alignment with Express: Explain how the changes align with the Express API. | ||
| - [ ] API Longevity: Discuss the steps taken to ensure that the new or updated APIs are consistent and not prone to breaking changes. | ||
| - [ ] Examples: Provide examples demonstrating the new features or changes in action. | ||
|
|
||
| ## Type of Change | ||
|
|
||
| Please delete options that are not relevant. | ||
|
|
||
| - [ ] New feature (non-breaking change which adds functionality) | ||
| - [ ] Enhancement (improvement to existing features and functionality) | ||
| - [ ] Documentation update (changes to documentation) | ||
| - [ ] Performance improvement (non-breaking change which improves efficiency) | ||
| - [ ] Code consistency (non-breaking change which improves code reliability and robustness) | ||
|
|
||
| ## Checklist | ||
|
|
||
| Before you submit your pull request, please make sure you meet these requirements: | ||
|
|
||
| - [ ] Followed the inspiration of the Express.js framework for new functionalities, making them similar in usage. | ||
| - [ ] Conducted a self-review of the code and provided comments for complex or critical parts. | ||
| - [ ] Updated the documentation in the `/docs/` directory for [Fiber's documentation](https://docs.gofiber.io/). | ||
| - [ ] Added or updated unit tests to validate the effectiveness of the changes or new features. | ||
| - [ ] Ensured that new and existing unit tests pass locally with the changes. | ||
| - [ ] Verified that any new dependencies are essential and have been agreed upon by the maintainers/community. | ||
| - [ ] Aimed for optimal performance with minimal allocations in the new code. | ||
| - [ ] Provided benchmarks for the new code to analyze and improve upon. | ||
|
|
||
| ## Commit Formatting | ||
|
|
||
| Please use emojis in commit messages for an easy way to identify the purpose or intention of a commit. You can refer to the emoji cheatsheet here: https://gitmoji.carloscuesta.me/ | ||
|
|