Skip to content

Commit

Permalink
Add ISSUE_TEMPLATE and PULL_REQUEST_TEMPLATE (#113)
Browse files Browse the repository at this point in the history
Summary:
Add ISSUE_TEMPLATE and PULL_REQUEST_TEMPLATE

Pull Request resolved: #113

Test Plan: Not needed. These are the same templates used in https://github.com/mlcommons/chakra.

Differential Revision: D57299654

Pulled By: briancoutinho

fbshipit-source-id: 38b456180aadb8b09562fbbc1ef1e38a39ee8eff
  • Loading branch information
TaekyungHeo authored and facebook-github-bot committed May 13, 2024
1 parent 9b1946f commit 675754e
Show file tree
Hide file tree
Showing 4 changed files with 55 additions and 0 deletions.
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: ''
assignees: ''
---

## Describe the Bug
> A clear and concise description of what the bug is.
## Steps to Reproduce
> Steps to reproduce the behavior.
> Please include the version information where the bug was observed.
## Expected Behavior
> A clear and concise description of what you expected to happen.
## Screenshots
> If applicable, add screenshots to help explain your problem.
13 changes: 13 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: ''
assignees: ''
---

## Problem Related to the Feature
> A clear and concise description of what the problem is.
## Proposed Solution
> A clear and concise description of what you want to happen.
9 changes: 9 additions & 0 deletions .github/ISSUE_TEMPLATE/general_question.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
name: General question
about: Ask a question or seek clarification about the project
title: ''
labels: 'question'
assignees: ''
---

> Please provide a detailed description of your question or the information you seek.
13 changes: 13 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
## Summary
Provide a concise summary of the changes introduced by this pull request. Detail the purpose and scope of the changes, referencing any relevant issues or discussions. Explain how these changes address the problem or improve the project.

## Test Plan
In this section, describe the testing you have performed to verify the changes. Include:
- A clear description of the testing environment.
- The steps you followed to test the new features or bug fixes.
- Any specific commands used during testing, along with their outputs.
- A description of the results and observations from your testing.
This information is crucial for reviewers to understand how the changes have been validated.

## Additional Notes
Include any other notes or comments about the pull request here. This can include challenges faced, future considerations, or context that reviewers might find helpful.

0 comments on commit 675754e

Please sign in to comment.