Skip to content

Commit

Permalink
chore(github): issues and pr templates
Browse files Browse the repository at this point in the history
  • Loading branch information
goulvenclech committed Nov 29, 2024
1 parent 57aaaaa commit 582ef6d
Show file tree
Hide file tree
Showing 3 changed files with 52 additions and 0 deletions.
32 changes: 32 additions & 0 deletions .github/ISSUE_TEMPLATE/01-bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
name: "Bug Report"
description: Report an issue or possible bug
labels: []
assignees: []
body:
- type: markdown
attributes:
value: |
## Quick Checklist
Thank you for taking the time to file a bug report! Please fill out this form as completely as possible. If you're not sure how to fill out a section, do your best and we'll help you along the way.
# TODO: When the extensions and the crates will be published, we should add a block to ask the versions concerned by the bug.
- type: textarea
id: bug-description
attributes:
label: Describe the Bug
description: A clear and concise description of what the bug is.
validations:
required: true
- type: textarea
id: bug-expectation
attributes:
label: What's the expected result?
description: Describe what you expect to happen.
validations:
required: true
- type: checkboxes
id: will-pr
attributes:
label: Participation
options:
- label: I am willing to submit a pull request for this issue.
required: false
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
blank_issues_enabled: false
contact_links:
- name: Any ideas or suggestions?
url: https://github.com/web-lsp/weblsp/discussions/categories/ideas
about: Propose and discuss future improvements to WEBlsp.
- name: Support or help needed?
url: https://github.com/web-lsp/weblsp/discussions/categories/q-a
about: Ask questions and get help from the community.
12 changes: 12 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
## What does this change?

- Be short and concise. Bullet points can help!
- Before/after screenshots can help as well.

## How is it tested?

<!-- DON'T DELETE THIS SECTION! If no tests added, explain why. -->

## How is it documented?

<!-- DON'T DELETE THIS SECTION! If no docs added, explain why.-->

0 comments on commit 582ef6d

Please sign in to comment.