GitHub pull request template for openmrs-core

teleivo · April 26, 2016, 8:11am

Hello all,

I just added a pull request template for the radiology module

openmrs/openmrs-module-radiology/blob/master/.github/PULL_REQUEST_TEMPLATE.md

<!--- Provide PR Title above as: 'RAD-JiraIssueNumber JiraIssueTitle' -->

## Description
<!--- Describe your changes in detail -->

## Related Issue
<!--- This project only accepts pull requests related to open issues -->
<!--- If suggesting a new feature or change, please discuss it in an issue
first -->
<!--- If fixing a bug, there should be an issue describing it with steps to
reproduce -->
<!--- Please link to the issue here: -->
see https://issues.openmrs.org/browse/RAD-

## Checklist:
<!--- Go over all the following points, and put an `x` in all the boxes that
apply. -->
<!--- If you're unsure about any of these, don't hesitate to ask. We're here to
help! -->
- [ ] My pull request only contains one single commit.

This file has been truncated. show original

This will make it easier for contributors and especially new ones. They just have to fill in the JIRA issue number and fill in a description of what the PR is about. It also provides a little checklist of common things I see are almost always missing! (one commit, based on latest master branch, tests, run build and ensure formatting changes are in the commit, …)

Do you want me to create a ticket+PR for openmrs-core for some more pull request harmony ?

see github feature https://help.github.com/articles/creating-a-pull-request-template-for-your-repository/

darius · April 26, 2016, 8:23am

Haven’t looked closely, but I think this is a brilliant idea, and it makes sense to bring this good practice to OpenMRS core also.

-Darius (by phone)

teleivo · April 26, 2016, 9:05am

created a ticket https://issues.openmrs.org/browse/TRUNK-4863 I’ll create a PR after it has been assessed

raff · April 26, 2016, 9:36am

Assessed! Nice idea!

teleivo · April 26, 2016, 11:30am

done at

https://github.com/openmrs/openmrs-core/pull/1786

r0bby · April 26, 2016, 8:55pm

Nice – I’m not gonna create one for all other repos I’m responsible for – I see no point – sometimes I don’t want to have it as one…I can manually squash commits myself and merge it by hand.

teleivo · April 27, 2016, 6:52am

the PR template checklist is just a text guide (mainly aimed at new contributors), so you can of course still create PRs with multiple commits. you could also create your own template without the checklist or a different one. it at least helps the lazy me not having to type the jira issue link again and again