Skip to content

Commit

Permalink
Add ISSUE_TEMPLATE and PULL_REQUEST_TEMPLATE (#2875)
Browse files Browse the repository at this point in the history
* Add ISSUE_TEMPLATE and PULL_REQUEST_TEMPLATE

Add ISSUE_TEMPLATE and PULL_REQUEST_TEMPLATE to the .github directory. These templates are designed to assist contributors in reporting issues and submitting pull requests by providing guidance on the necessary information to include. This helps streamline the contribution process for both issue reporting and pull requests.

* prettier

---------

Co-authored-by: Fun117 <fun117.kun@gmail.com>
Co-authored-by: Dimitri POSTOLOV <dmytropostolov@gmail.com>
  • Loading branch information
3 people authored Sep 28, 2024
1 parent 4a789ed commit 2eb580b
Show file tree
Hide file tree
Showing 4 changed files with 82 additions and 0 deletions.
File renamed without changes.
36 changes: 36 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: bug
assignees: ''
---

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

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

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.

**Desktop (please complete the following information):**

- OS: [e.g. iOS]
- Browser [e.g. chrome, safari]
- Version [e.g. 22]

**Smartphone (please complete the following information):**

- Device: [e.g. iPhone6]
- OS: [e.g. iOS8.1]
- Browser [e.g. stock browser, safari]
- Version [e.g. 22]

**Additional context** Add any other context about the problem here.
19 changes: 19 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: enhancement
assignees: ''
---

**Is your feature request related to a problem? Please describe.** A clear and
concise description of what the problem is. Ex. I'm always frustrated when [...]

**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.
27 changes: 27 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
<!--
Thank you for contributing to this project! You must fill out the information below before we can review this pull request. By explaining why you're making a change (or linking to an issue) and what changes you've made, we can triage your pull request to the best possible team for review.
-->

### Why:

Closes:

<!-- If there's an existing issue for your change, please link to it above.
If there's _not_ an existing issue, please open one first to make it more likely that this update will be accepted: https://github.com/shuding/nextra/issues/new/choose. -->

### What's being changed (if available, include any code snippets, screenshots, or gifs):

<!-- Let us know what you are changing. Share anything that could provide the most context. -->

### Check off the following:

- [ ] I have reviewed my changes in staging, available via the **View
deployment** link in this PR's timeline (this link will be available after
opening the PR).

- For content changes, you will also see an automatically generated comment
with links directly to pages you've modified. The comment won't appear if
your PR only edits files in the `data` directory.

- [ ] For content changes, I have completed the
[self-review checklist](https://docs.github.com/en/contributing/collaborating-on-github-docs/self-review-checklist).

0 comments on commit 2eb580b

Please sign in to comment.