From 73e6811bc096fd9b136ac5b0ddfde02cbfbf677b Mon Sep 17 00:00:00 2001 From: Martyanov Andrey <37772440+martyanovandrey@users.noreply.github.com> Date: Thu, 12 Dec 2024 15:01:50 +0300 Subject: [PATCH] chore: add templates for issue&pr (#348) --- .github/ISSUE_TEMPLATE/1-bug-report.yml | 47 ++++++++++++++++++++ .github/ISSUE_TEMPLATE/2-feature_request.yml | 23 ++++++++++ .github/ISSUE_TEMPLATE/config.yml | 5 +++ .github/pull_request_template.md | 20 +++++++++ 4 files changed, 95 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/1-bug-report.yml create mode 100644 .github/ISSUE_TEMPLATE/2-feature_request.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/pull_request_template.md diff --git a/.github/ISSUE_TEMPLATE/1-bug-report.yml b/.github/ISSUE_TEMPLATE/1-bug-report.yml new file mode 100644 index 00000000..96300221 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/1-bug-report.yml @@ -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. diff --git a/.github/ISSUE_TEMPLATE/2-feature_request.yml b/.github/ISSUE_TEMPLATE/2-feature_request.yml new file mode 100644 index 00000000..714b41a2 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/2-feature_request.yml @@ -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? diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..25ba4e7d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: true +contact_links: + - name: Комьюнити чат (RU) + url: https://t.me/diplodoc_ru + about: Спросить у сообщества diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 00000000..d2518dfc --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,20 @@ + + +## Description + + + +Related issue: #(issue number) + +