Skip to content

Commit

Permalink
Add basic issue and pull-request templates
Browse files Browse the repository at this point in the history
This PR adds an issue and PR template in this repo, heavily inspired
from those of the Eclipse Theia project.

Signed-off-by: Marc Dumais <[email protected]>
  • Loading branch information
marcdumais-work committed Nov 27, 2024
1 parent 386c54e commit 7947675
Show file tree
Hide file tree
Showing 5 changed files with 71 additions and 1 deletion.
26 changes: 26 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
name: Bug Report (except security vulnerabilities)
about: Create a report to help us improve
---

<!-- Please provide a detailed description of the bug. -->
<!-- Note: This template is not meant for security vulnerabilities disclosure -->
<!-- Any such issue, created in this repo, will be deleted on sight -->
<!-- Instead please report vulnerabilities to the Eclipse Foundation's security team -->
<!-- For more details, please read SECURITY.md in the repository root -->
### Bug Description:

<!-- Please provide clear steps to reproduce the bug. -->
### Steps to Reproduce:

1.
2.
3.

<!-- Please provide any additional information available. -->
<!-- Additional information can be in the form of logs, screenshots, screencasts. -->

### Additional Information

- Operating System:
- Theia Version:
9 changes: 9 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
name: Feature Request
about: Propose an idea for the project
---

<!-- Please fill out the following content for a feature request. -->

<!-- Please provide a clear description of the feature and any relevant information. -->
### Feature Description:
9 changes: 9 additions & 0 deletions .github/ISSUE_TEMPLATE/question.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
name: Question
about: Ask a question related to the content of this repository
---

<!-- Please fill out the following content for a question. -->

<!-- Please provide a clear description of your question and include any relevant information. -->
### Your question:
26 changes: 26 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
<!--
Thank you for your Pull Request. Please provide a description and review
the requirements below.
Contributors guide: https://github.com/theia-ide/theia/blob/master/CONTRIBUTING.md
Note: Security vulnerabilities should not be disclosed on GitHub, through a PR or any
other means. See SECURITY.md at the root of this repository, to learn how to report
vulnerabilities.
-->

#### What it does

<!-- Include relevant issues and describe how they are addressed. -->

#### How to test

<!-- Explain how a reviewer can reproduce a bug, test new functionality or verify performance improvements. -->

#### Follow-ups

<!-- Please list potential follow-up work, including known issues, possible future work, identified technical debt, and potentially introduced technical debt. If the PR introduces technical debt, specify the reason why this is acceptable. Please create tickets and link them here. Please use the label "technical debt" for new issues when it applies. -->

#### Review checklist

- [ ] As an author, I have thoroughly tested my changes and carefully followed the instructions in this template
2 changes: 1 addition & 1 deletion SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,5 @@ If you think or suspect that you have discovered a new security vulnerability in

Instead, please report any potential vulnerability to the Eclipse Foundation [Security Team][security]. Make sure to provide a concise description of the issue, a CWE, and other supporting information.

[policy]: https://www.eclipse.org/security/policy.php
[policy]: https://www.eclipse.org/security/policy/
[security]: https://www.eclipse.org/security

0 comments on commit 7947675

Please sign in to comment.