Selaa lähdekoodia

Add Issue Template and update PR template (#2823)

Nate 8 vuotta sitten
vanhempi
commit
c3d19ff4dd
2 muutettua tiedostoa jossa 26 lisäystä ja 9 poistoa
  1. 23 0
      .github/ISSUE_TEMPLATE.md
  2. 3 9
      .github/PULL_REQUEST_TEMPLATE.md

+ 23 - 0
.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,23 @@
+<!--
+Before opening an issue, please make sure you have checked the documentation for help/answers at http://frameworkbenchmarks.readthedocs.io/en/latest/
+
+If this issue is regarding documentation, please open that issue at our documentation repo at https://github.com/TechEmpower/TFB-Documentation
+
+If this is a feature request please check the project roadmaps first at https://github.com/TechEmpower/FrameworkBenchmarks/projects
+
+If this is a request for a new language/framework please check/add to the wiki at https://github.com/TechEmpower/FrameworkBenchmarks/wiki/Suggested-Frameworks,-Languages-and-Features
+
+If this issue is related to personal benchmarking numbers versus official round results, please make sure you are testing on the same commit that the round was released on and that your machine setup is similar to the specs listed for that round otherwise it will be extremely difficult to reproduce results. Rounds are tagged at https://github.com/TechEmpower/FrameworkBenchmarks/releases
+
+For errors with setup, frameworks, or the toolset, please make sure you are on the most current `master` branch. Provide as many logs as possible. For larger logs you can use http://sprunge.us/ then follow the template below:
+-->
+
+### OS (Please include kernel version)
+
+### Expected Behavior
+
+### Actual Behavior
+
+### Steps to reproduce behavior
+
+### Other details and logs

+ 3 - 9
.github/PULL_REQUEST_TEMPLATE.md

@@ -1,13 +1,7 @@
 <!--
-....................................
+Thank you for submitting to the TechEmpower Framework Benchmarks!
 
-MAKE SURE YOU ARE OPENING A PULL
-REQUEST AGAINST THE CORRECT BRANCH
+If you are submitting a new framework please make sure that you add the appropriate line in the `.travis.yml` file for proper integration testing and that an appropriate `README.md` is added in your framework directory with information about the framework and a link to it's homepage and documentation.
 
-....................................
-
-master = currently open to all pull
-requests for Round 14.
-
-....................................
+If you are editing an existing test, please update the `README.md` for that test where appropriate. The original contributor will most likely be pinged for feedback with `mention-bot`.
 -->