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

(hackday) - Finalising the default PR default message #260

Closed
wants to merge 1 commit into from
Closed

Conversation

pmcmaw
Copy link
Contributor

@pmcmaw pmcmaw commented Nov 23, 2018

Please ensure that you have completed all of the following steps:

  • Provided your PR with a meaningful title as this will become an entry in the CHANGELOG.md
  • Documented your change in the README.md if necessary
  • Included tests for your functionality
  • Added a label to categorize your change
  • Confirmed that all tests are passing

This is an example of a great PR. For additional information please see our contributing guidelines. If you are intrigued as to why we label PRs, please check out this blog post.

Someone from Puppet will review your PR as soon as possible.

Thank you for taking the time to contribute to our supported modules.

@davidmalloncares
Copy link

davidmalloncares commented Nov 23, 2018

  • maybe say "Please ensure.."
  • change first 'off' to 'of'
  • maybe include a link to an example for labels, some good docs example or tests?

@eimlav
Copy link

eimlav commented Nov 23, 2018

Perhaps provide a title example and ensure to specify a ticket or use (maint)

@pmcmaw
Copy link
Contributor Author

pmcmaw commented Nov 23, 2018

@eimlav @davidmalloncares how does that middle paragraph look? Or is it something specific yous have in mind for examples? If so can you drop me an example of the example you mean please :-)

@pmcmaw pmcmaw changed the title testing (hackday) - Finalising the default PR default message Nov 23, 2018
@davidmalloncares
Copy link

davidmalloncares commented Nov 23, 2018

The link to contributing guidelines is a good addition.

Do we document how contributors should use 'labels' anywhere? Feels like linking to a bit more info on that could be helpful.

on docs and tests - I don't have a specific example but is there somewhere we could like to for good examples of docs/readme or tests?

@pmcmaw
Copy link
Contributor Author

pmcmaw commented Nov 23, 2018

@davidmalloncares so I have linked a good example of a PR that includes everything you need. As for the labels, there isnt really an example. To be honest I think it may be self explanatory, however I can start working on a blog post for labelling, then when its published, it could be linked?

@davidmalloncares
Copy link

@pmcmaw aye its up to you, if labels are pretty clear then maybe we don't need anything, but if it is not that clear then if we refer to them it would be nice to be able to link to more info somewhere

@DavidS DavidS deleted the readme branch October 15, 2020 13:59
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.

None yet

4 participants