Added pull request template.
authorArmin Novak <armin.novak@thincast.com>
Thu, 23 Nov 2017 15:44:00 +0000 (16:44 +0100)
committerArmin Novak <armin.novak@thincast.com>
Mon, 27 Nov 2017 08:07:29 +0000 (09:07 +0100)
.github/ISSUE_TEMPLATE.md
.github/PULL_REQUEST_TEMPLATE.md [new file with mode: 0644]

index 4e4a051..02b98fe 100644 (file)
@@ -1,27 +1,22 @@
-See https://github.com/FreeRDP/FreeRDP/wiki/BugReporting for details on bug reports first!
-
-* Please don't "report" questions as bugs
-
-Found a bug? - We would like to help you and smash the bug away.
-
+## Found a bug? - We would like to help you and smash the bug away.
+1. __Please don't "report" questions as bugs.__
+  * We are reachable via IRC _#freerdp on freenode_
+  * Try our mailing list for discussions/questions
 1. Before reporting a bug have a look into our issue tracker to see if the bug was already reported and you can add some additional information.
-1. If it's a new bug - create a new issue.
- To save time and help us identify the issue a bug report should at least contain the following:
-
-    *  an useful description of the bug - "It's not working" isn't good enough - you must try harder ;)
-    * the steps to reproduce the bug
-    * command line you have used
-    * to what system did you connect to? (win8, 2008, ..)
-    * what did you expect to happen?
-    * what actually happened?
-    * freerdp version (e.g. xfreerdp --version) or package version or git commit
-    * freerdp configuration (e.g. xfreerdp --buildconfig)
-    * operating System, architecture, distribution e.g. linux, amd64, debian
-    * if you built it yourself add some notes which branch you have used, also your cmake parameters can help
-    * extra information helping us to find the bug
-
-* If you have question join us in irc (#freerdp on freenode) or write a mail to our mailing list.
+1. If it's a __new__ bug - create a new issue.
+1. For more details see https://github.com/FreeRDP/FreeRDP/wiki/BugReporting
 
-Thank you for reporting a bug!
+## To save time and help us identify the issue a bug report should at least contain the following:
+  * a useful description of the bug - "It's not working" isn't good enough - you must try harder ;)
+  * the steps to reproduce the bug
+  * command line you have used
+  * to what system did you connect to? (win8, 2008, ..)
+  * what did you expect to happen?
+  * what actually happened?
+  * freerdp version (e.g. xfreerdp --version) or package version or git commit
+  * freerdp configuration (e.g. xfreerdp --buildconfig)
+  * operating System, architecture, distribution e.g. linux, amd64, debian
+  * if you built it yourself add some notes which branch you have used, also your cmake parameters can help
+  * extra information helping us to find the bug
 
+_Thank you for reporting a bug!_
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
new file mode 100644 (file)
index 0000000..de3ea77
--- /dev/null
@@ -0,0 +1,22 @@
+## This is how are pull requests handled by FreeRDP
+1. Every new pull request needs to build and pass the unit tests at https://ci.freerdp.com
+1. At least 1 (better two) people need to review and test a pull request and agree to accept
+
+## Preparations before creating a pull
+* Rebase your branch to current master, no merges allowed!
+* Try to clean up your commit history, group changes to commits
+* Check your formatting! A _astyle_ script can be found at ```./scripts/format_code.sh```
+* Optional (but higly recommended)
+  * Run a clang scanbuild before and after your changes to avoid introducing new bugs
+  * Run your compiler at pedantic level to check for new warnings
+
+## To ease accepting your contribution
+* Give the pull request a proper name so people looking at it have an basic idea what it is for
+* Add at least a brief description what it does (or should do :) and what it's good for
+* Give instructions on how to test your changes
+* Ideally add unit tests if adding new features
+
+## What you should be prepared for
+* fix issues found during the review phase
+* Joining IRC _#freerdp_ to talk to other developers or help them test your pull might accelerate acceptance
+