├── .github └── PULL_REQUEST_TEMPLATE ├── LICENSE ├── README.md ├── backend └── PULL_REQUEST_TEMPLATE ├── frontend └── PULL_REQUEST_TEMPLATE ├── oss └── PULL_REQUEST_TEMPLATE └── react-native └── PULL_REQUEST_TEMPLATE.md /.github/PULL_REQUEST_TEMPLATE: -------------------------------------------------------------------------------- 1 | Description of PR... 2 | 3 | ## Changes 4 | 5 | - Item 1 6 | - Item 2 7 | 8 | ## PR Template Checklist 9 | 10 | - [ ] Grammar 11 | - [ ] Spelling 12 | - [ ] Clarity 13 | 14 | Fixes #85, Fixes #22, Fixes username/repo#123 15 | Connects #123 16 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2016 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | ## Pull Request Templates 2 | 3 | ### Purpose 4 | 5 | Adding a pull request template to your project helps add clarity around 6 | contributing guidelines. The template helps enforce consistency and 7 | transparency around contributions to your code base. By supplementing your 8 | pull request with a detailed description, you help the contributor aggregate 9 | their work into a meaningful summary while providing more context for the 10 | code reviewer. 11 | 12 | This repo was created to share properties of a pull request description we 13 | consider to be useful during our code review process. We've taken some 14 | time to split these templates based on the type of project (e.g backend, 15 | frontend, open source library, etc...). Please feel free to use these templates 16 | within your own projects, and share with us by contributing to this project. 17 | 18 | ### Installation 19 | 20 | Check out your default branch, most of the time this is `master`: 21 | 22 | `git checkout master` 23 | 24 | Create a `.github` directory: 25 | 26 | ``` 27 | mkdir .github && cd .github 28 | ``` 29 | 30 | Once thats created, you need to download the template from this repo. To 31 | download the template you would like to use, you can run the following 32 | cURL command: 33 | 34 | ``` 35 | curl -O https://raw.githubusercontent.com/echobind/pr-templates/master/frontend/PULL_REQUEST_TEMPLATE 36 | ``` 37 | 38 | Every template is named `PULL_REQUEST_TEMPLATE` for easy installation, so you 39 | just need to update the path in order to retrieve the correct template. 40 | 41 | ### Copyright (c) 42 | 43 | ## Legal 44 | [Echobind](https://echobind.com) LLC (c) 2016 45 | [@echobind](https://twitter.com/echobind) 46 | [Licensed under the MIT license](http://www.opensource.org/licenses/mit-license.php) 47 | -------------------------------------------------------------------------------- /backend/PULL_REQUEST_TEMPLATE: -------------------------------------------------------------------------------- 1 | Description of PR that completes issue here... 2 | 3 | ## Changes 4 | 5 | - Item 1 6 | - Item 2 7 | - Item 3 8 | 9 | ## Requests / Responses 10 | 11 | **Request** 12 | 13 | POST `/api/users` Returns a list of users 14 | 15 | ``` 16 | { 17 | "data": { 18 | "attributes": { 19 | "name": "The Dude", 20 | "email": "thedudeabides@wee.net", 21 | "password": "hellopassword" 22 | } 23 | }, 24 | "type": "users" 25 | } 26 | ``` 27 | 28 | **Response** 29 | 30 | HTTP/1.1 200 OK 31 | 32 | ``` 33 | { 34 | "data": { 35 | "type": "users", 36 | "id": "4", 37 | "attributes": { 38 | "name": "The Dude", 39 | "email": "thedudeabides@wee.net", 40 | "last-logged-in": null, 41 | "created-at": "2016-10-20T17:45:08.190Z", 42 | "updated-at": "2016-10-20T17:45:08.190Z" 43 | }, 44 | "links": { 45 | "self": "/users/4" 46 | } 47 | } 48 | } 49 | ``` 50 | 51 | ## Testing 52 | 53 | - [ ] Deploy to staging 54 | - [ ] Run migrations 55 | - [ ] Manually QA update 56 | - [ ] Get approval from stakeholder 57 | - [ ] Determine production deploy timing 58 | 59 | ## Production Ready 60 | 61 | - [ ] Deploy to production 62 | - [ ] Run migrations 63 | - [ ] Sanity check on production 64 | - [ ] Monitor logs for errors 65 | 66 | Fixes #85, Fixes #22, Fixes username/repo#123 67 | Connects #123 68 | -------------------------------------------------------------------------------- /frontend/PULL_REQUEST_TEMPLATE: -------------------------------------------------------------------------------- 1 | Description of PR that completes issue here... 2 | 3 | ## Changes 4 | 5 | - Description of changes 6 | 7 | ## Screenshots 8 | 9 | (prefer animated gif) 10 | 11 | ## Checklist 12 | 13 | - [ ] Requires dependency update? 14 | - [ ] Automated tests 15 | - [ ] Looks good on large screens 16 | - [ ] Looks good on mobile 17 | 18 | Closes [TICKET-14](https://linktoticket.com/ticket-number-14) 19 | -------------------------------------------------------------------------------- /oss/PULL_REQUEST_TEMPLATE: -------------------------------------------------------------------------------- 1 | Description of PR... 2 | 3 | ## Changes 4 | 5 | - Item 1 6 | - Item 2 7 | 8 | ## API Updates 9 | 10 | ### New Features *(required)* 11 | 12 | This section should include details regarding new features added to the library. 13 | This should include both open and private APIs. If including both, create two 14 | sub headers underneath this one to label updates accordingly. 15 | 16 | ### Deprecations *(required)* 17 | 18 | All deprecations should be listed here in order to ensure the reviewer understands 19 | which sections of the codebase will affect contributors and users of the library. 20 | 21 | ### Enhancements *(optional)* 22 | 23 | The enhancements section should include code updates that were included with this 24 | pull request. This sections should detail refactoring that might have affected 25 | other parts of the library. 26 | 27 | ## Checklist 28 | 29 | - [ ] Unit tests 30 | - [ ] Documentation 31 | 32 | ## References 33 | 34 | (optional) 35 | 36 | Include __important__ links regarding the implementation of this PR. 37 | This usually includes and RFC or an aggregation of issues and/or individual conversations 38 | that helped put this solution together. This helps ensure there is a good aggregation 39 | of resources regarding the implementation. 40 | 41 | Fixes #85, Fixes #22, Fixes username/repo#123 42 | Connects #123 43 | -------------------------------------------------------------------------------- /react-native/PULL_REQUEST_TEMPLATE.md: -------------------------------------------------------------------------------- 1 | Overview / Description 2 | 3 | ## Changes 4 | - Change 1 5 | - Change 2 6 | 7 | ## Screenshots 8 | (prefer animated gif) 9 | 10 | ## Checklist 11 | - [ ] Automated tests 12 | - [ ] Checked on iOS 13 | - [ ] Checked on Android 14 | 15 | Fixes #xx 16 | --------------------------------------------------------------------------------