From e4ea49267f922f7b3509c59d05607f76b384ee07 Mon Sep 17 00:00:00 2001 From: Eric Putnam Date: Mon, 21 Oct 2019 08:55:09 -0700 Subject: [PATCH 1/3] (maint) updates README with github issues info We are switching over to GitHub issues for this repository (away from JIRA). This change updates the README to reflect the change. --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 3504c1df7..af179069c 100644 --- a/README.md +++ b/README.md @@ -8,13 +8,13 @@ Puppet Strings generates documentation for Puppet code and extensions written in | | | | -------------- |---------------------------------------------------------------- | | *Code* | [GitHub][repo] | -| *Issues* | [Puppet JIRA Tracker][JIRA] | +| *Issues* | [GitHub issues][issues] | | *License* | [Apache 2.0][LICENSE] | | *Change log* | [CHANGELOG.md][changelog] | | *Contributing* | [CONTRIBUTING.md][contributing] and [COMMITTERS.md][committers] | [repo]: https://github.com/puppetlabs/puppet-strings -[JIRA]: https://tickets.puppetlabs.com/browse/PDOC +[issues]: https://github.com/puppetlabs/puppet-strings/issues [LICENSE]: https://github.com/puppetlabs/puppet-strings/blob/master/LICENSE [changelog]: https://github.com/puppetlabs/puppet-strings/blob/master/CHANGELOG.md [contributing]: https://github.com/puppetlabs/puppet-strings/blob/master/CONTRIBUTING.md @@ -135,7 +135,7 @@ An example of run the acceptance tests follow the instructions [here]. ## Support -Please log tickets and issues in our [JIRA tracker][JIRA]. A [mailing list](https://groups.google.com/forum/?fromgroups#!forum/puppet-users) is available for asking questions and getting help from others. +Please log issues in [GitHub issues][issues]. A [mailing list](https://groups.google.com/forum/?fromgroups#!forum/puppet-users) is available for asking questions and getting help from others. There is also an active #puppet channel on the Freenode IRC network. From ee5212729ec2791fbe6be53bb8d4e283922ff45e Mon Sep 17 00:00:00 2001 From: Eric Putnam Date: Mon, 21 Oct 2019 09:08:11 -0700 Subject: [PATCH 2/3] (maint) adds section in CONTRIBUTING for issues To provide a little bit of help/set expectations around issues, this change adds a section to CONTRIBUTING.md and references it in the README. --- CONTRIBUTING.md | 32 ++++++++++++++++++++++++++++++++ README.md | 4 +++- 2 files changed, 35 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0b266072e..324417fd5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -14,6 +14,38 @@ that we can have a chance of keeping on top of things. * Make sure you fill in the earliest version that you know has the issue. * Fork the repository on GitHub +## Submit an issue + +We use GitHub Issues for issue tracking on puppet-strings. + +Before you submit your issue, take a minute to... + +1. **Use the GitHub issue search** — check if the issue has already been + reported. + +2. **Check if the issue has been fixed** — try to reproduce it using the + latest `master` or release tag. + +A good bug report shouldn't leave others needing to chase you up for more +information. Please try to be as **detailed as possible** in your issue. What is +your environment? What steps will reproduce the issue? + +Example: + +> Short and descriptive example issue title +> +> A summary of the issue with details about the environment it occurs in (Ruby version, Puppet version, Strings version, etc). If +> suitable, include the steps required to reproduce the bug. +> +> 1. This is the first step +> 2. This is the second step +> 3. Further steps, etc. +> +> Any other information you want to share that is relevant to the issue being +> reported. This might include the lines of code that you have identified as +> causing the bug, and potential solutions (and your opinions on their +> merits). + ## Making Changes * Create a topic branch from where you want to base your work. diff --git a/README.md b/README.md index af179069c..f9fb86602 100644 --- a/README.md +++ b/README.md @@ -135,7 +135,9 @@ An example of run the acceptance tests follow the instructions [here]. ## Support -Please log issues in [GitHub issues][issues]. A [mailing list](https://groups.google.com/forum/?fromgroups#!forum/puppet-users) is available for asking questions and getting help from others. +Please log issues in [GitHub issues][issues]. Check out [CONTRIBUTING.md][contributing] for tips on writing _the best_ issues. + +A [mailing list](https://groups.google.com/forum/?fromgroups#!forum/puppet-users) is available for asking questions and getting help from others. There is also an active #puppet channel on the Freenode IRC network. From e5d075413204a66981edd81d54e07490722d2abb Mon Sep 17 00:00:00 2001 From: Eric Putnam Date: Mon, 21 Oct 2019 13:53:58 -0700 Subject: [PATCH 3/3] (maint) adds Slack info, removes JIRA stragglers and IRC info --- CONTRIBUTING.md | 2 -- README.md | 19 +++++++++++-------- 2 files changed, 11 insertions(+), 10 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 324417fd5..4384a0127 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -7,7 +7,6 @@ that we can have a chance of keeping on top of things. ## Getting Started -* Make sure you have a [Jira account](http://tickets.puppetlabs.com) * Make sure you have a [GitHub account](https://github.com/signup/free) * Submit a ticket for your issue, assuming one does not already exist. * Clearly describe the issue including steps to reproduce when it is a bug. @@ -130,7 +129,6 @@ To cut a new release, from a current `master` checkout: # Additional Resources * [More information on contributing](http://links.puppet.com/contribute-to-puppet) -* [Bug tracker (Jira)](http://tickets.puppet.com) * [Contributor License Agreement](http://links.puppet.com/cla) * [General GitHub documentation](http://help.github.com/) * [GitHub pull request documentation](http://help.github.com/send-pull-requests/) diff --git a/README.md b/README.md index f9fb86602..a0a1dbdc3 100644 --- a/README.md +++ b/README.md @@ -13,13 +13,6 @@ Puppet Strings generates documentation for Puppet code and extensions written in | *Change log* | [CHANGELOG.md][changelog] | | *Contributing* | [CONTRIBUTING.md][contributing] and [COMMITTERS.md][committers] | -[repo]: https://github.com/puppetlabs/puppet-strings -[issues]: https://github.com/puppetlabs/puppet-strings/issues -[LICENSE]: https://github.com/puppetlabs/puppet-strings/blob/master/LICENSE -[changelog]: https://github.com/puppetlabs/puppet-strings/blob/master/CHANGELOG.md -[contributing]: https://github.com/puppetlabs/puppet-strings/blob/master/CONTRIBUTING.md -[committers]: https://github.com/puppetlabs/puppet-strings/blob/master/COMMITTERS.md - ## Installing Puppet Strings ### Requirements @@ -139,8 +132,18 @@ Please log issues in [GitHub issues][issues]. Check out [CONTRIBUTING.md][contri A [mailing list](https://groups.google.com/forum/?fromgroups#!forum/puppet-users) is available for asking questions and getting help from others. -There is also an active #puppet channel on the Freenode IRC network. +There is also an active community on the [Puppet community Slack][] in the #forge-modules channel. We use semantic version numbers for our releases and recommend that users upgrade to patch releases and minor releases as they become available. Bug fixes and ongoing development will occur in minor releases for the current major version. Security fixes will be ported to a previous major version on a best-effort basis, until the previous major version is no longer maintained. + + +[repo]: https://github.com/puppetlabs/puppet-strings +[issues]: https://github.com/puppetlabs/puppet-strings/issues +[LICENSE]: https://github.com/puppetlabs/puppet-strings/blob/master/LICENSE +[changelog]: https://github.com/puppetlabs/puppet-strings/blob/master/CHANGELOG.md +[contributing]: https://github.com/puppetlabs/puppet-strings/blob/master/CONTRIBUTING.md +[committers]: https://github.com/puppetlabs/puppet-strings/blob/master/COMMITTERS.md +[Puppet community Slack]: https://slack.puppet.com +