From cd0e59ffa9df62697d567a838b465749c37bb9fc Mon Sep 17 00:00:00 2001 From: Xaver Maierhofer Date: Tue, 7 Feb 2017 01:47:10 +0100 Subject: [PATCH] [DOC] Add github templates --- .github/CONTRIBUTING.md | 5 +++++ .github/ISSUE_TEMPLATE.md | 33 ++++++++++++++++++++++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 20 +++++++++++++++++++ 3 files changed, 58 insertions(+) create mode 100644 .github/CONTRIBUTING.md create mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000..87332fb --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,5 @@ +## Contributing is welcome + +Pull requests are welcome without an opening an issue. If you unsure about the feature or implementation open an issue and +discuss your suggested changes. Meshviewer is a frontend application and the code needs to be loaded and +perform on slow mobile devices with many nodes and clients. diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 0000000..ef479a6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,33 @@ + + + +## Expected Behavior + + + +## Current Behavior + + + +## Possible Solution + + + +## Steps to Reproduce (for bugs) + + +1. +2. +3. +4. + +## Context + + + +## Your Environment + +* Version used: +* Browser Name and version: +* Operating System and version (desktop or mobile): +* Link to your project: diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..396dd7d --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,20 @@ + + +## Description + + +## Motivation and Context + + + +## How Has This Been Tested? + + +## Screenshots/links (if appropriate): + +## Checklist: + + +- [ ] My code follows the code style of this project. (CI will test it anyway and also needs approval) +- [ ] My change requires a change to the documentation. +- [ ] I have updated the documentation accordingly.