Skip to content
Snippets Groups Projects
  1. Aug 03, 2018
  2. May 09, 2018
  3. Jan 30, 2018
    • Melissa Stone's avatar
      (docs) Update the contributing guidelines · 322c7def
      Melissa Stone authored
      This commit updates CONTRIBUTING.md to include more up to date
      information on our contribution guidelines.
      
      This includes more details around running tests and more guidance around
      the definition of a trivial contribution.
      322c7def
  4. Nov 29, 2017
  5. Nov 14, 2017
    • Melissa Stone's avatar
      (docs) Provide instructions on running puppet unit tests · 996a9a7c
      Melissa Stone authored
      This commits adds in a few details on exactly how to run all the tests.
      Prior to this commit, we simply had a mandate that users run tests
      before opening pull requests. This commit details how to do that. Users
      are only expected to ensure the unit tests are passing prior to opening
      a pull request.
      996a9a7c
  6. Sep 23, 2017
    • Garrett Guillotte's avatar
      (docs) Make formatting and punctuation consistent. · b844cad1
      Garrett Guillotte authored
      Punctuation and Markdown formatting is inconsistent in parts of
      CONTRIBUTING.md. Improve the document's consistency to make
      rendering more reliable and improve readability.
      b844cad1
    • Garrett Guillotte's avatar
      (docs) Align CONTRIBUTING.md with Travis CI. · e777743e
      Garrett Guillotte authored
      When creating a commit summary, Travis CI can fail claiming it doesn't
      match CONTRIBUTING.md guidelines:
      
      ```
      This commit summary didn't match CONTRIBUTING.md guidelines:
        (DOCUMENT-729) Add context to static_catalogs setting.
      The commit summary (i.e. the first line of the commit message) should
      start with one of:
        (PUP-<digits>) # this is most common and should be a ticket at
      tickets.puppet.com
        (docs)
        (docs)(DOCUMENT-<digits>)
        (maint)
        (packaging)
      This test for the commit summary is case-insensitive.
      ```
      
      Of these five rules for the start of a commit message, only the first,
      `(PUP-<digits>)`, is documented in CONTRIBUTING.md, and is documented
      ambiguously; it is unclear that only the PUP Jira project is accepted,
      and that others will fail.
      
      The second, `(docs)`, is listed in CONTRIBUTING incorrectly as `(doc)`.
      
      The rest — `(docs)(DOCUMENT-<digits>)`, `(maint)`, and `(packaging)` —
      are not documented at all.
      
      This is a problem because a contributor might be unable to write a
      valid, complete, and representative commit message despite following
      the guidelines in CONTRIBUTING.md, and the message Travis CI produces
      upon failure suggests rules that do not exist in CONTRIBUTING.md.
      
      Resolve this issue by editing and adding to the rules in
      CONTRIBUTING.md to match the output of the Travis CI error message.
      e777743e
  7. Jul 06, 2017
  8. Apr 06, 2017
  9. Mar 30, 2017
  10. Jan 23, 2017
  11. Oct 28, 2016
    • John Duarte's avatar
      (PUP-6840) Add revert policy · bc0a01c0
      John Duarte authored
      This commit outlines the revert policy for code changes that result
      in test pipeline failures. The purpose of this is to establish a
      clear protocol for when a revert should take place and how it should
      be communicated to the original contributor.
      bc0a01c0
  12. Apr 21, 2016
  13. Nov 10, 2015
  14. Nov 09, 2015
    • Samuel Keeley's avatar
      (PUP-5123) Replace http:// links with https:// · 0c32e9d5
      Samuel Keeley authored
      This replaces most http:// links with https:// The
      replaced ones have all been verified to serve
      identical content.  Those which aren't replaced are
      contained within XML schema or are internal puppetlabs
      links which are unable to be verified externally. Some
      are also outdated and inaccessible and should be updated
      seperately.
      0c32e9d5
  15. Oct 07, 2015
  16. Mar 11, 2015
    • Ruth Linehan's avatar
      (maint) Update links in CONTRIBUTING.md · 58c5d41f
      Ruth Linehan authored
      Remove an old link to the mostly-dead wiki, add links to puppet-dev email list
      archive, #puppet-dev IRC archive, and community triage notes. Clean up some
      white space errors.
      58c5d41f
  17. Dec 23, 2014
  18. Jun 04, 2014
  19. Apr 23, 2014
    • Andrew Parker's avatar
      (maint) Include information about how PRs are handled · 820a3a1b
      Andrew Parker authored
      Our process and expectations around how pull requests are handled hasn't
      been the most clear. This causes problems not only for those submitting
      pull requests, but also for those handling them. This tries to lay some
      ground rules.
      820a3a1b
  20. Dec 23, 2013
  21. Sep 20, 2013
  22. Mar 11, 2013
  23. Aug 03, 2012
    • Jeff McCune's avatar
      Mark git diff --check as inline code · 6f7303a5
      Jeff McCune authored
      6f7303a5
    • Jeff McCune's avatar
      Make the example in CONTRIBUTING imperative and concrete · cf04e5ef
      Jeff McCune authored
      Without this patch applied the example commit message in the CONTRIBUTING
      document is not a concrete example.  This is a problem because the
      contributor is left to imagine what the commit message should look like
      based on a description rather than an example.  This patch fixes the
      problem by making the example concrete and imperative.
      
      The first line is a real life imperative statement with a ticket number
      from our issue tracker.  The body describes the behavior without the patch,
      why this is a problem, and how the patch fixes the problem when applied.
      cf04e5ef
    • Jeff McCune's avatar
      Add HOWTO hint on topic branches in CONTRIBUTING · 9862940a
      Jeff McCune authored
      Without this patch it's not very clear how to create a topic branch.
      This has been a problem in the past because we often get pull requests
      from the master branch to the master branch which can be confusing when
      working outside of the GitHub Web UI.
      
      This patch addresses the problem by providing a concrete example of how
      to create a reasonable topic branch and start using it with two
      commands.
      9862940a
    • Jeff McCune's avatar
      (Maint) Whitespace cleanup of CONTRIBUTING.md · 9c60ed3d
      Jeff McCune authored
      Just noticed some whitespace errors.  This is a whitespace only change
      that removes trailing whitespace from CONTRIBUTING.md
      9c60ed3d
    • Andrew Parker's avatar
      (Maint) Simplify CONTRIBUTING.md · 65b35a86
      Andrew Parker authored
      The previous CONTRIBUTING.md was verbose and prone to change as branches
      changed. After discussion on puppet-dev I've cut it down a lot and changed the
      policy for which branch to target to be a "prefer master" policy where it is up
      to the merger to make sure it will go on the right branch.
      65b35a86
  24. Jul 31, 2012
  25. Jul 26, 2012
    • Hailee Kenney's avatar
      Replace "the short version" with outline · a26d1eeb
      Hailee Kenney authored
      Previously, the short version/checklist at the beginning did not line
      up with the rest of the document, and was presenting information in 
      a confusing order. Now it reflects the way the information is organized
      in the larger document, and serves as a good checklist for going through
      the process. 
      a26d1eeb
  26. Jul 25, 2012
    • Hailee Kenney's avatar
      Update CONTRIBUTING.md · 6a43e969
      Hailee Kenney authored
      6a43e969
    • Hailee Kenney's avatar
      (Maint) Remove some more ambiguity · c44973c4
      Hailee Kenney authored
      Remove the pieces of the document that say we support email and
      Redmine patches, instead of just saying that we strongly
      discourage these. Also change the places where we say "we recommend"
      when what we really mean is "we require". Lastly, make a few small
      changes that were brought up on the PR.
      
      <hailee@puppetlabs.com>
      c44973c4
  27. Jul 23, 2012
    • Hailee Kenney's avatar
      (Maint) Be more honest about submission methods · 00b563d1
      Hailee Kenney authored
      While CONTRIBUTING.md makes it clear that GitHub is the best method
      for submitting changes, it's important that we be honest about the
      fact that Redmine and email patches have a tendency to get lost
      (sometimes forever). Hopefuly this change will encourage people
      even more to use GitHub as apposed to other methods of contributing.
      
      <hailee@puppetlabs.com>
      00b563d1
    • Hailee Kenney's avatar
      (Maint) Clarify that Redmine tickets are mandatory · b90c92b2
      Hailee Kenney authored
      Prior to this commit, it was unclear if it was required to have
      a Redmine ticket before submitting a pull request. Now it is clear
      that this is a requirement in order to help us keep track of
      submissions.
      
      Also add details about looking for already existing tickets that
      are either duplicates or related. This should help with the issue
      of having tons of tickets all related to one bigger issue which
      cannot be tracked easily.
      
      <hailee@puppetlabs.com>
      b90c92b2
    • Hailee Kenney's avatar
      (Maint) Clarify which branches changes should be based on · 62c14bd1
      Hailee Kenney authored
      Priror to this commit, CONTRIBUTING.md did not reflect our current
      process in regards to where changes should be targeted. Now it is
      clear on these issues so that it will be easier for community
      members to target their submissions to the right location, and
      prevent us from frequently having to kick back pull requests that
      need to be rebased and retargeted.
      
      <hailee@puppetlabs.com>
      62c14bd1
  28. May 04, 2012
  29. Feb 24, 2012
  30. Aug 03, 2011
    • Jacob Helwig's avatar
      Add document outlining preferred contribution methods · c833fde3
      Jacob Helwig authored
      
      We have historically had the preferred contribution process on the
      Redmine wiki, however this is not obvious to people that don't already
      know it is there.  By adding this document to the repository itself,
      it becomes much easier for new contributors to find what the preferred
      contribution methods are.
      
      By having the preferred contribution method in the repository also
      means that it becomes a "curated" document, which must go through the
      same submission/review process that other changes to the repositories
      go through.
      
      Reviewed-by: default avatarNick Fagerlund <nick.fagerlund@puppetlabs.com>
      Reviewed-by: default avatarNick Lewis <nick@puppetlabs.com>
      c833fde3
    • Jacob Helwig's avatar
      Add document outlining preferred contribution methods · c8835ad0
      Jacob Helwig authored
      
      We have historically had the preferred contribution process on the
      Redmine wiki, however this is not obvious to people that don't already
      know it is there.  By adding this document to the repository itself,
      it becomes much easier for new contributors to find what the preferred
      contribution methods are.
      
      By having the preferred contribution method in the repository also
      means that it becomes a "curated" document, which must go through the
      same submission/review process that other changes to the repositories
      go through.
      
      Reviewed-by: default avatarNick Fagerlund <nick.fagerlund@puppetlabs.com>
      Reviewed-by: default avatarNick Lewis <nick@puppetlabs.com>
      c8835ad0
    • Jacob Helwig's avatar
      Add document outlining preferred contribution methods · b85f57cc
      Jacob Helwig authored
      
      We have historically had the preferred contribution process on the
      Redmine wiki, however this is not obvious to people that don't already
      know it is there.  By adding this document to the repository itself,
      it becomes much easier for new contributors to find what the preferred
      contribution methods are.
      
      By having the preferred contribution method in the repository also
      means that it becomes a "curated" document, which must go through the
      same submission/review process that other changes to the repositories
      go through.
      
      Reviewed-by: default avatarNick Fagerlund <nick.fagerlund@puppetlabs.com>
      Reviewed-by: default avatarNick Lewis <nick@puppetlabs.com>
      b85f57cc
Loading