From bb67fd7286b99ae63f5af47e930569c44b9e5619 Mon Sep 17 00:00:00 2001 From: Chris Gorgolewski Date: Fri, 15 Mar 2019 11:01:26 -0700 Subject: [PATCH] [INFRA] Adding instructions for naming PRs --- CONTRIBUTING.md | 16 ++++++++++++++++ pull_request_template.md | 17 +++++++++++++++++ 2 files changed, 33 insertions(+) create mode 100644 pull_request_template.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b3ccb3db16..6732f9f22b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -95,6 +95,22 @@ Try to keep the changes focused. If you submit a large amount of work in all in #### 4. Submit a [pull request](https://help.github.com/articles/about-pull-requests/) +Please keep the title of your pull request short but informative - it will +appear in the changelog. + +Use one of the following prefixes in the title of your pull request: + - `[ENH]` - enhancement of the specification that adds a new feature or + support for a new data type + - `[FIX]` - fix of a typo or language clarification + - `[INFRA]` - changes to the infrastructure automating the specification + release (for example building HTML docs etc.) + - `[MISC]` - everything else including changes to the file listing + contributors + +If you are opening a pull request to obtain early feedback, but the changes +are not ready to be merged (a.k.a. Work in Progress pull request) please +use [draft pull request](https://github.blog/2019-02-14-introducing-draft-pull-requests/). + A member of the BIDS Specification team will review your changes to confirm that they can be merged into the main codebase. A [review](https://help.github.com/articles/about-pull-request-reviews/) will probably consist of a few questions to help clarify the work you've done. Keep an eye on your github notifications and be prepared to join in that conversation. diff --git a/pull_request_template.md b/pull_request_template.md new file mode 100644 index 0000000000..82f0ea4863 --- /dev/null +++ b/pull_request_template.md @@ -0,0 +1,17 @@ +--- PLEASE READ AND DELETE THE TEXT BELOW BEFORE OPENING THE PULL REQUEST --- + +- Please keep the title of your pull request short but informative - it will + appear in the changelog +- Use one of the following prefixes in the title of your pull request: + - `[ENH]` - enhancement of the specification that adds a new feature or + support for a new data type + - `[FIX]` - fix of a typo or language clarification + - `[INFRA]` - changes to the infrastructure automating the specification + release (for example building HTML docs etc.) + - `[MISC]` - everything else including changes to the file listing + contributors +- If you are opening a pull request to obtain early feedback, but the changes + are not ready to be merged (a.k.a. Work in Progress pull request) please + use [draft pull request](https://github.blog/2019-02-14-introducing-draft-pull-requests/) + +--- PLEASE READ AND DELETE THE TEXT ABOVE BEFORE OPENING THE PULL REQUEST --- \ No newline at end of file