Add issue templates

This commit is contained in:
Fabing Li 2024-06-21 17:42:31 +08:00 committed by Tate, Hongliang Tian
parent d2eb9e16ff
commit c75a3732b9
9 changed files with 238 additions and 0 deletions

4
.github/ISSUE_TEMPLATE/blank_issue.md vendored Normal file
View File

@ -0,0 +1,4 @@
---
name: Blank Issue
about: Create a blank issue.
---

44
.github/ISSUE_TEMPLATE/bug_report.md vendored Normal file
View File

@ -0,0 +1,44 @@
---
name: Bug Report
about: Create a bug report to help us improve our operating system.
title: Brief description of the problem
labels: C-bug
---
<!-- Thank you for taking the time to report a bug. Your input is valuable to us.
Please replace all the <angle brackets> below with your own information. -->
### Describe the bug
<!-- A clear and concise description of what the bug is. -->
### To Reproduce
<!-- Steps to reproduce the behavior. Example:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error -->
### Expected behavior
<!-- A clear and concise description of what you expected to happen. -->
### Screenshots
<!-- If applicable, add screenshots to help explain your problem. -->
### Environment
<!-- Please fill out this information as completely as possible:
- Hardware platform (e.g., Intel(R) Xeon(R) Gold 6342 CPU) -->
### Additional context
<!-- Add any other context about the problem here. For example, did the issue start occurring recently or has it always been there? -->
### Logs
<!-- If applicable, add log snippets or files to help explain and debug the problem. Please use code blocks (```) to format logs. -->
<!-- Once again, thank you for helping us improve our project! -->

5
.github/ISSUE_TEMPLATE/config.yml vendored Normal file
View File

@ -0,0 +1,5 @@
blank_issues_enabled: true
contact_links:
- name: Discussion
url: https://asterinas.zulipchat.com
about: Please ask and answer questions about Asterinas on the user forum.

26
.github/ISSUE_TEMPLATE/documentation.md vendored Normal file
View File

@ -0,0 +1,26 @@
---
name: Documentation Request
about: Suggest improvements or additions to the documentation
title: Concise description of the documentation issue or suggestion
labels: C-documentation
---
<!-- Thank you for contributing to our documentation! Documentation improvements help everyone better understand and use the operating system. Please provide us with clear and detailed information about the issue or suggestion. -->
### Documentation Section
<!-- Please identify the section or page of the documentation where you are suggesting an improvement. Include a URL if possible.-->
### Suggested Improvement
<!-- Clearly and concisely describe the improvement you are suggesting. Are you proposing corrections, additions, or modifications? Please be specific and provide as much detail as possible to explain your suggestion. -->
### Motivation and Context
<!-- Why is this improvement important? Explain the context behind your documentation request. For example, did you find the current documentation unclear, lacking in detail, or incorrect? How will your suggestion improve the documentation? -->
### Additional Information
<!-- Include any additional information, such as references to external documentation, screenshots, or examples, that will help clarify your suggestion. -->
<!-- Your contributions to making our documentation more clear and comprehensive are greatly appreciated! -->

34
.github/ISSUE_TEMPLATE/enhancement.md vendored Normal file
View File

@ -0,0 +1,34 @@
---
name: Enhancement Request
about: Suggest an enhancement for an existing feature of this operating system
title: Concise description of the enhancement
labels: C-enhancement
---
<!-- Thank you for taking the time to suggest an enhancement for our operating system. Please provide a clear and concise description of the enhancement you want and the reasons why it would be beneficial. -->
### Current Feature
<!-- Describe the existing feature or behavior that you are proposing to enhance. Please be specific. -->
### Enhancement Description
<!-- Clearly and concisely describe the enhancement you are proposing. Explain how it should work in practice and what the expected benefits are. -->
### Motivation
<!-- Explain why this enhancement would be useful to most operating system users. Provide specific use cases, experiences, or issues with the current functionality that this enhancement would address. -->
### Possible Implementations
<!-- If you have ideas on how to implement this enhancement, please detail them here. This can include:
- Technical implementation details, design considerations, or architecture sketches
- Modifications to user interface, system behavior, or core functionality
- Code snippets, pseudo-code, or example scenarios -->
### Additional Context
<!-- Add any other context, mock-ups, sketches, screenshots, or examples that could help clarify the enhancement request. -->
<!-- We appreciate your initiative in proposing this enhancement and your help in making our operating system better! -->

View File

@ -0,0 +1,35 @@
---
name: Feature Request
about: Propose a new feature to add to this operating system
title: Concise description of the new feature
labels: C-feature-request
---
<!-- Thank you for taking the time to suggest a feature for our operating system.
Please help us understand your proposal by filling out the information below. -->
### Feature Description
<!-- Clearly and concisely describe the feature you'd like to have added. What is it? How should it work? -->
### Problem or Need
<!-- If this feature addresses a specific problem or need you have encountered, describe it. Why is the feature important or beneficial to you and potentially other users? -->
### Suggested Implementation
<!-- If you have an idea of how this feature should be implemented, provide details here. This can include:
- Technical details, design considerations, or architecture diagrams
- Third-party libraries or services, if applicable
- Pseudo-code, API method names, or sample code snippets -->
### Possible Alternatives
<!-- If you've considered any alternative solutions or workarounds, please list those here. -->
### Additional Context and Screenshots
<!-- Provide any additional context that could help us understand the feature request better. Screenshots, mockups, and diagrams are also welcomed. -->
<!-- Again, we greatly appreciate your contribution to improving our operating system! -->

26
.github/ISSUE_TEMPLATE/question.md vendored Normal file
View File

@ -0,0 +1,26 @@
---
name: Question
about: Ask a question or seek clarification about Asterinas
title: Short summary of your question
labels: C-question
---
<!-- Please ensure your question has not been answered in our documentation before submitting. Thank you for reaching out with your question! -->
### Your Question
<!-- Provide a clear and concise description of what you want to know or need clarification about. -->
### What You Have Tried
<!-- Let us know what you've tried to do to find an answer to your question. This can include documentation you've reviewed, search engines you've consulted, and so on. -->
### Relevant Documentation or Forum Link
<!-- If there is a part of the documentation or a forum thread that's relevant to your question, please provide a link here. -->
### Additional context
<!-- Provide any other context or details that might be helpful for answering your question. -->
<!-- We appreciate your engagement and are happy to help you get the most out of our operating system! -->

46
.github/ISSUE_TEMPLATE/rfc.md vendored Normal file
View File

@ -0,0 +1,46 @@
---
name: RFC Submission
about: Propose a new idea or significant change for consideration
title: Concise description of the proposal
labels: C-rfc
---
<!-- Thank you for taking the time to propose a new idea or significant change. Please provide a comprehensive overview of the concepts and motivations at play. -->
### Summary
<!-- Briefly summarize the idea, change, or feature you are proposing. What is it about, and what does it aim to achieve? -->
### Context and Problem Statement
<!-- Describe the problem or inadequacy of the current situation/state that your proposal is addressing. This is a key aspect of putting your RFC into context. -->
### Proposal
<!-- Clearly and comprehensively describe your proposal including high-level technical specifics, any new interfaces or APIs, and how it should integrate into the existing system. -->
### Motivation and Rationale
<!-- Elaborate on why this proposal is important. Provide justifications for why it should be considered and what benefits it brings. Include use cases, user stories, and pain points it intends to solve. -->
### Detailed Design
<!-- Dive into the nitty-gritty details of your proposal. Discuss possible implementation strategies, potential issues, and how the proposal would alter workflows, behaviors, or structures. Include pseudocode, diagrams, or mock-ups if possible. -->
### Alternatives Considered
<!-- Detail any alternative solutions or features you've considered. Why were they discarded in favor of this proposal? -->
### Additional Information and Resources
<!-- Offer any additional information, context, links, or resources that stakeholders might find helpful for understanding the proposal. -->
### Open Questions
<!-- List any questions that you have that might need further discussion. This can include areas where you are seeking feedback or require input to finalize decisions. -->
### Future Possibilities
<!-- If your RFC is likely to lead to subsequent changes, provide a brief outline of what those might be and how your proposal may lay the groundwork for them. -->
<!-- We appreciate your effort in contributing to the evolution of our system and look forward to reviewing and discussing your ideas! -->

View File

@ -0,0 +1,18 @@
---
name: Tracking Issue
about: Track the progress of a specific task or feature
title: Short summary of the task or feature
labels: C-tracking-issue
---
### Description
<!-- Provide a brief description of the task or feature being tracked -->
### Current Status
<!-- Describe the current status or progress of the task or feature -->
### Additional Information
<!-- Add any other relevant information, links, or context related to the tracking issue -->