From cb5ba4cc3b09decc9e514de4bae89343ede94120 Mon Sep 17 00:00:00 2001 From: Clinton Alexander Date: Tue, 5 Sep 2017 18:07:17 +0100 Subject: [PATCH] Minor improvements to github templates. --- .github/ISSUE_TEMPLATE.md | 2 +- .github/PULL_REQUEST_TEMPLATE.md | 20 ++++++++++++-------- 2 files changed, 13 insertions(+), 9 deletions(-) diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index a033b80436..37dc57e9fa 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -3,6 +3,6 @@ Thank you for choosing to report an issue with Corda. When reporting an issue please make sure it contains; * A clear description of the issue -* Any logs or stack traces that you can provide (use a site like [pastebin](https://pastebin.com)for larger logs) +* Any logs or stack traces that you can provide (use a site like https://pastebin.com for larger logs) * Steps to reproduce the issue * The version/tag/release or commit hash it occured on \ No newline at end of file diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 7946da9d1f..fa66ea084c 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,17 +1,21 @@ Thank you for choosing to contribute to Corda. -## PR Process +PR Process +---------- -Your PR must be approved by one or more reviewers and all tests must be passed on [TeamCity CI](https://ci.corda.r3cev.com) +Your PR must be approved by one or more reviewers and all tests must be passed on TeamCity (https://ci.corda.r3cev.com) in order to be merged. Once you have submitted a PR you are responsible for keeping it up to date until the time it is merged. -## PR Checklist +PR Checklist +------------ -1. Ensure any new code is tested as described [here](https://docs.corda.net/testing.html) +1. Ensure any new code is tested as described in https://docs.corda.net/testing.html 2. Ensure you have done any relevant automated testing and manual testing -3. Add your changes to `docs/source/changelog.rst` -4. Update any documentation in `docs/source` relating to your changes and learn how to build them [here](https://docs.corda.net/building-the-docs.html) -5. If you are contributing for the first time please read the agreement in [CONTRIBUTING](../contributing.md) now - and add to this Pull Request that you have read, and agreed to, the agreement. +3. Add your changes to docs/source/changelog.rst +4. Update any documentation in docs/source relating to your changes and learn how to build them in https://docs.corda.net/building-the-docs.html +5. If you are contributing for the first time please read the agreement in CONTRIBUTING.md now and add to this + Pull Request that you have read, and agreed to, the agreement. + +Please remove this message when you have read it.