Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/marian-nmt/marian.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRoman Grundkiewicz <rgrundki@exseed.ed.ac.uk>2020-03-17 06:10:18 +0300
committerGitHub <noreply@github.com>2020-03-17 06:10:18 +0300
commit9ccb07536531af28fc734a679ba5051470c18a35 (patch)
treef5ef798c22ead156f139fa6232925809f3becd3f /.github
parentadba021a5e6fee65870d16eae9d88319b07fa9bb (diff)
Add templates for GitHub issues and pull requests
Diffstat (limited to '.github')
-rw-r--r--.github/ISSUE_TEMPLATE/bug_report.md21
-rw-r--r--.github/ISSUE_TEMPLATE/config.yml1
-rw-r--r--.github/ISSUE_TEMPLATE/feature_request.md15
-rw-r--r--.github/pull_request_template.md25
4 files changed, 62 insertions, 0 deletions
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
new file mode 100644
index 00000000..bd7a8e72
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,21 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+### Bug description
+Please add a clear and concise description of the bug, including observed and if possible expected behavior.
+
+### How to reproduce
+Describe steps or include command to reproduce the behavior.
+
+### Context
+* Marian version: Paste the output of `--version` here
+* CMake command: Type the cmake command you used and attach the output of `--build-info all`
+* Log file: Attach your training/decoding logs
+
+Add any other information about the problem here.
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
new file mode 100644
index 00000000..0086358d
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1 @@
+blank_issues_enabled: true
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
new file mode 100644
index 00000000..340ae57d
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -0,0 +1,15 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: enhancement
+assignees: ''
+
+---
+
+### Feature description
+Please add a concise description of what the problem is and describe the solution you would like to see.
+Add links to a paper, another toolkit, etc. if relevant.
+
+### Example
+Add a usage examples for the new feature, e.g. a command line.
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
new file mode 100644
index 00000000..53599544
--- /dev/null
+++ b/.github/pull_request_template.md
@@ -0,0 +1,25 @@
+### Description
+Please add a clear and concise description of the changes.
+
+This PR fixes a bug/adds a new feature/refactorizes the code/does something else.
+It is related to issues: #998, #999, ...
+
+List of changes:
+- ...
+- ...
+- ...
+
+Added dependencies: none
+
+### How to test
+Describe how to test your changes, adding command line examples and sample input/output files if relevant.
+Point to unit tests or regression tests covering the changes if they have been added.
+
+Describe how you have tested your code, including OS and the cmake command.
+
+### Checklist
+
+- [ ] I have tested the code manually
+- [ ] I have run regression tests
+- [ ] I have read and followed CONTRIBUTING.md
+- [ ] I have updated CHANGELOG.md