Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add .github folder with issue and pull request templates #20

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
about: Create a bug report to help improve the project. Use this template for reporting bugs or requesting features. For questions or seeking help, please use the discussion forum.
title: "[BUG] Issue title..."
labels: bug
assignees: @ylacombe, @sanchit-gandhi

---

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behavior:

1.
2.

**Expected behavior**
A clear and concise description of what you expected to happen.

**Screenshots**
If applicable, add screenshots to help explain your problem.

**Additional context**
Add any other context about the problem here (version tags, repository/library versions, etc.)
21 changes: 21 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
name: Feature request
about: Suggest an idea for this project. Hparam requests, training help are not feature requests. Use this template for proposing new features. For questions or seeking help, please use the discussion forum.
title: "[FEATURE] Feature title..."
labels: enhancement
assignees: ''

---

**Is your feature request related to a problem? Please describe.**

A clear and concise description of what the problem is.

**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
Add any other context or screenshots about the feature request here.
40 changes: 40 additions & 0 deletions .github/PULL_REQUEST.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# What does this PR do?

<!--
Replace this with a concise summary of what this pull request accomplishes. Describe the changes made and the issue fixed, if applicable. Provide relevant context and motivation for the changes. If there are any dependencies necessary for this change, list them here.
-->

## Summary

<!--
Provide a brief overview of the changes made in this pull request. Highlight the main issue fixed or improvement implemented. Keep it concise and informative.
-->

## Description of Changes

<!--
Detail the specific changes made in this pull request. Explain the problem addressed and how it was resolved. If applicable, provide before and after comparisons or any relevant details to help reviewers understand the changes easily.
-->

## Additional Information

<!--
Include any additional information or context that might be helpful for reviewers. This could include noticing the absence of templates, proposing to create them, or any other relevant information related to the contribution process or repository maintenance.
-->

## Before Submitting

- [ ] This PR fixes a typo/improves documentation/fixes issue #.
- [ ] Have you read the contributor guidelines and the Pull Request section?
- [ ] Was this change discussed or approved through an issue or the community forum? Please provide a link if applicable.
- [ ] Have you added any necessary tests for the changes made?

## Who can review?

<!--
Tag potential reviewers from the community or maintainers who might be interested in reviewing this pull request. This helps expedite the review process and ensures that the PR receives timely attention.
-->

<!-- Your PR will be reviewed more quickly if you can figure out the right person to tag with @ -->

@ylacombe OR @sanchit-gandhi