Skip to content

Commit

Permalink
chore: add templates for issue&pr (#348)
Browse files Browse the repository at this point in the history
  • Loading branch information
martyanovandrey authored Dec 12, 2024
1 parent aa4b805 commit 73e6811
Show file tree
Hide file tree
Showing 4 changed files with 95 additions and 0 deletions.
47 changes: 47 additions & 0 deletions .github/ISSUE_TEMPLATE/1-bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
name: Bug report
description: Create a report to help us improve
body:
- type: markdown
attributes:
value: |
Thank you for reporting an issue.
This issue tracker is for bugs and issues found within packege.
Please fill in as much of the following form as you're able.
- type: input
attributes:
label: Package version
- type: input
attributes:
label: Node version
description: |
Output of `node -v`.
- type: input
attributes:
label: Platform
- type: textarea
attributes:
label: What steps will reproduce the bug?
description: >
Enter details about your bug, preferably a simple code snippet that can
be run using without installing third-party dependencies
or downloading code from the internet.
validations:
required: true
- type: textarea
attributes:
label: What is the expected behavior?
description: If possible please provide screenshots or textual output.
validations:
required: true
- type: textarea
attributes:
label: What do you see instead?
description: If possible please provide screenshots or textual output.
validations:
required: true
- type: textarea
attributes:
label: Additional information
description: Tell us anything else you think we should know.
23 changes: 23 additions & 0 deletions .github/ISSUE_TEMPLATE/2-feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
name: Feature request
description: Suggest an idea for this project
labels: [feature request]
body:
- type: markdown
attributes:
value: |
Thank you for suggesting an idea to make Diplodoc better.
Please fill in as much of the following form as you're able.
- type: textarea
attributes:
label: What is the problem this feature will solve?
validations:
required: true
- type: textarea
attributes:
label: What is the feature you are proposing to solve the problem?
validations:
required: true
- type: textarea
attributes:
label: What alternatives have you considered?
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: true
contact_links:
- name: Комьюнити чат (RU)
url: https://t.me/diplodoc_ru
about: Спросить у сообщества
20 changes: 20 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
<!--
Thank you for submitting a Pull Request, before submitting, please read commit message formatting guidelines at https://www.conventionalcommits.org/en/v1.0.0/
For code changes:
1. Include tests for any bug fixes or new features.
2. Update documentation if relevant.
3. Ensure that the code is up-to-date with the `master` branch.
4. Include a description of the proposed changes and how to test them.
For Russian speaking contributors:
Перед отправкой PR-a, пожалуйста, прочтите гайды для разработчиков платформы Diplodoc : https://diplodoc.com/docs/ru/dev/
#xxxx" -->

## Description

<!-- Please include a summary of the changes. If it is feasible, it is worth attaching a screenshot or video of the changes. -->

Related issue: #(issue number)

<!-- If this is a bug fix, make sure your description includes "fixes #xxxx", or "closes #xxxx" -->

0 comments on commit 73e6811

Please sign in to comment.