Browse Source

Add issue / PR templates (fixes #5795)

Signed-off-by: Joffrey F <[email protected]>
Joffrey F 7 years ago
parent
commit
4e97e0fd41
2 changed files with 63 additions and 0 deletions
  1. 50 0
      docs/issue_template.md
  2. 13 0
      docs/pull_request.md

+ 50 - 0
docs/issue_template.md

@@ -0,0 +1,50 @@
+<!--
+Welcome to the docker-compose issue tracker! Before creating an issue, please heed the following:
+
+1. This tracker should only be used to report bugs and request features / enhancements to docker-compose
+    - For questions and general support, use https://forums.docker.com
+    - For documentation issues, use https://github.com/docker/docker.github.io
+    - For issues with the `docker stack` commands and the version 3 of the Compose file, use
+      https://github.com/docker/cli
+2. Use the search function before creating a new issue. Duplicates will be closed and directed to
+   the original discussion.
+3. When making a bug report, make sure you provide all required information. The easier it is for
+   maintainers to reproduce, the faster it'll be fixed.
+-->
+
+## Description of the issue
+
+## Context information (for bug reports)
+
+```
+Output of "docker-compose version"
+```
+
+```
+Output of "docker version"
+```
+
+```
+Output of "docker-compose config"
+```
+
+
+## Steps to reproduce the issue
+
+1.
+2.
+3.
+
+### Observed result
+
+### Expected result
+
+### Stacktrace / full error message
+
+```
+(if applicable)
+```
+
+## Additional information
+
+OS version / distribution, `docker-compose` install method, etc.

+ 13 - 0
docs/pull_request.md

@@ -0,0 +1,13 @@
+<!--
+Welcome to the docker-compose issue tracker, and thank you for your interest
+in contributing to the project! Please make sure you've read the guidelines
+in CONTRIBUTING.md before submitting your pull request. Contributions that
+do not comply and contributions with failing tests will not be reviewed!
+-->
+
+<!-- Please make sure an issue describing the problem the PR is trying to
+    solve exists, or create it before submitting a PR. The maintainers will
+    validate if the issue should be addressed or if it out of scope for the
+    project.
+-->
+Resolves #