search

habitat-sh / core-plans

Core Habitat Plan definitions
130 stars 253 forks source link

[proposal] Standard PR request format #3242

Open gavindidrichsen opened 4 years ago

gavindidrichsen commented 4 years ago

@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://github.com/habitat-sh/core-plans/pull/3239#issuecomment-593171950 image

stevendanna commented 4 years ago

We can add a pull request template to try to encourage this:

https://help.github.com/en/github/building-a-strong-community/creating-a-pull-request-template-for-your-repository

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.

gavindidrichsen commented 4 years ago

Thanks @stevendanna. I'll put this on my backlog and review with you after the refresh.

MindNumbing commented 4 years ago

@gavindidrichsen are you still keen to look into this?

predominant commented 4 years ago

I approve of this message.