Open gavindidrichsen opened 4 years ago
We can add a pull request template to try to encourage this:
I'm cool with this as long as we are pragmatic about it. I think our goal should be to encourage high-quality commit message rather than adherence to any particular format. So, as long as the commit message or PR description tells us what we need to know, I wouldn't ask contributors to change them.
The test method and results are clearly defined and I know right away as a reviewer that (1) tests exists for this plan and (2) the tests have actually been run.
I think for (1) I'd prefer if some automation commented on the issue and for (2) I think we have our CI system. But, I agree that until we have those things, it is nice to put them in the PR description.
Thanks @stevendanna. I'll put this on my backlog and review with you after the refresh.
@gavindidrichsen are you still keen to look into this?
I approve of this message.
@predominant usually submits his PRs in the format below and I'd like to propose that all core-plans PRs be submitted in this fashion. The test method and results are clearly defined and I know right away as a reviewer that (1) tests exists for this plan and (2) the tests have actually been run.
https://github.com/habitat-sh/core-plans/pull/3240#issuecomment-593172970![image](https://user-images.githubusercontent.com/16652757/75665852-ba4c3000-5c6c-11ea-81d3-3e258e179b94.png)
https://github.com/habitat-sh/core-plans/pull/3239#issuecomment-593171950![image](https://user-images.githubusercontent.com/16652757/75668523-55470900-5c71-11ea-805a-9b3f3bbaafac.png)