Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make PR template more pertinent to docs changes #180

Closed
wants to merge 2 commits into from

Conversation

rgee0
Copy link
Contributor

@rgee0 rgee0 commented Oct 1, 2019

Signed-off-by: Richard Gee [email protected]

Description

  • Small change to README so that the local development section can be linked from the new template.
  • Pull in suggestions from the original issue and remove less relevant checklist items

Motivation and Context

How Has This Been Tested?

Its an issue template

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I've read the CONTRIBUTION guide
  • I have signed-off my commits with git commit -s

@jonatasbaldin
Copy link
Contributor

Nice, I like it 💃

- [ ] My change requires a change to the documentation.
- [ ] I have updated the documentation accordingly.
- [ ] I have tested any new instructions
- [ ] I am the author
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this declaration makes sense, but some people (international speakers, perhaps) may assume this means that they created the PR. Can we be more specific, but remain concise?

Do we need both?

What about:

- [ ] I have included copyrighted materials from third parties.
- [ ] I have permission to use copyrighted materials from third parties.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To some extent this is also covered under the DCO

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

addressed

@Waterdrips
Copy link
Contributor

I like this a lot!

@alexellis alexellis closed this Mar 12, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Create an issue / PR template that makes sense for documentation
4 participants