From 2f16e8e58494ba7aa5ac9865540b2d3b9aa66e69 Mon Sep 17 00:00:00 2001 From: Marko Petric <marko.petric@cern.ch> Date: Thu, 23 Mar 2017 13:43:39 +0100 Subject: [PATCH] Add CONTRIBUTING.md and PULL_REQUEST_TEMPLATE --- .github/CONTRIBUTING.md | 23 +++++++++++++++++++++++ .github/PULL_REQUEST_TEMPLATE | 8 ++++++++ 2 files changed, 31 insertions(+) create mode 100644 .github/CONTRIBUTING.md create mode 100644 .github/PULL_REQUEST_TEMPLATE diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 000000000..02ecb9d3a --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,23 @@ +# Contribution Guidelines for DD4hep + + +## Pull Requests + +When making a `Pull Request` please explain what and why things were +changed. Please include a short description in the +BEGINRELEASENOTES/ENDRELEASENOTES block, which will appear in the +doc/ReleaseNotes.md of the given package, once a new tag is made. + +## Coding Conventions + + * Your code should not introduce any new warnings, and fix as many existing warnings as possible + + +## Git workflow + +For an explanation of the git(hub) workflow please see +[here](https://github.com/andresailer/tutorial#working-updating-pushing). We +basically follow the ["No Switch +Yard"](https://root.cern.ch/suggested-work-flow-distributed-projects-nosy) +workflow + diff --git a/.github/PULL_REQUEST_TEMPLATE b/.github/PULL_REQUEST_TEMPLATE new file mode 100644 index 000000000..bd3f7f29d --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE @@ -0,0 +1,8 @@ + + +BEGINRELEASENOTES +- Thank you for writing the text to appear in the release notes. It will show up + exactly as it appears between the two bold lines +- ... + +ENDRELEASENOTES \ No newline at end of file -- GitLab