search

CCI-MOC / hil

Hardware Isolation Layer, formerly Hardware as a Service
Apache License 2.0
24 stars 54 forks source link

Propose/Create PULL_REQUEST_TEMPLATE.md #935

Closed xuhang57 closed 6 years ago

xuhang57 commented 6 years ago

Github feature: This patch proposes a Pull Request Template so that each PR can have a thorough description. Please feel free to discuss the content.

naved001 commented 6 years ago

I think we already have this under developer guidelines (docs/developer-guidelines.md), perhaps you could update those?

xuhang57 commented 6 years ago

@naved001 as discussed

naved001 commented 6 years ago

Just in case you didn't what this does (like me a few minutes ago), this is what @xuhang57 is doing

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

xuhang57 commented 6 years ago

I believe it is possible to have contribution guidelines in such as: Contributing.md. I am not sure whether it will prompt the user to read or not whenever a user is trying to start a PR.

And maybe not having such a long checklist but having a simple checklist in the PR imho could save time for both contributors and reviewers ;)

xuhang57 commented 6 years ago

https://help.github.com/articles/setting-guidelines-for-repository-contributors/

maybe this works

But I still think these two features serve two different purposes. What do you guys think?

naved001 commented 6 years ago

I still think these two features serve two different purposes. What do you guys think?

All it says is to describe what their PR is doing and to refer to the issue, and whoever has read* the github docs would know how to do that hopefully. I think the contribution guidelines page is good enough (since it will display a prompt on top when submitting a PR) and this might not be necessary.

zenhack commented 6 years ago

I agree pull request templates serve a somewhat different purpose than the contributing doc, but I also don't think we need a pr template as-is; the message directing folks to read the contribution guidelines seems like it should cover what's here currently.