Skip to content

Commit e4c0bbe

Browse files
authored
Merge pull request #216 from puppetlabs/MAINT/readme-issues-update
(maint) docs updates for GitHub issues changeover
2 parents 7ab4718 + e5d0754 commit e4c0bbe

File tree

2 files changed

+47
-12
lines changed

2 files changed

+47
-12
lines changed

CONTRIBUTING.md

Lines changed: 32 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,44 @@ that we can have a chance of keeping on top of things.
77

88
## Getting Started
99

10-
* Make sure you have a [Jira account](http://tickets.puppetlabs.com)
1110
* Make sure you have a [GitHub account](https://github.com/signup/free)
1211
* Submit a ticket for your issue, assuming one does not already exist.
1312
* Clearly describe the issue including steps to reproduce when it is a bug.
1413
* Make sure you fill in the earliest version that you know has the issue.
1514
* Fork the repository on GitHub
1615

16+
## Submit an issue
17+
18+
We use GitHub Issues for issue tracking on puppet-strings.
19+
20+
Before you submit your issue, take a minute to...
21+
22+
1. **Use the GitHub issue search** — check if the issue has already been
23+
reported.
24+
25+
2. **Check if the issue has been fixed** — try to reproduce it using the
26+
latest `master` or release tag.
27+
28+
A good bug report shouldn't leave others needing to chase you up for more
29+
information. Please try to be as **detailed as possible** in your issue. What is
30+
your environment? What steps will reproduce the issue?
31+
32+
Example:
33+
34+
> Short and descriptive example issue title
35+
>
36+
> A summary of the issue with details about the environment it occurs in (Ruby version, Puppet version, Strings version, etc). If
37+
> suitable, include the steps required to reproduce the bug.
38+
>
39+
> 1. This is the first step
40+
> 2. This is the second step
41+
> 3. Further steps, etc.
42+
>
43+
> Any other information you want to share that is relevant to the issue being
44+
> reported. This might include the lines of code that you have identified as
45+
> causing the bug, and potential solutions (and your opinions on their
46+
> merits).
47+
1748
## Making Changes
1849

1950
* Create a topic branch from where you want to base your work.
@@ -98,7 +129,6 @@ To cut a new release, from a current `master` checkout:
98129
# Additional Resources
99130

100131
* [More information on contributing](http://links.puppet.com/contribute-to-puppet)
101-
* [Bug tracker (Jira)](http://tickets.puppet.com)
102132
* [Contributor License Agreement](http://links.puppet.com/cla)
103133
* [General GitHub documentation](http://help.github.com/)
104134
* [GitHub pull request documentation](http://help.github.com/send-pull-requests/)

README.md

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,18 +8,11 @@ Puppet Strings generates documentation for Puppet code and extensions written in
88
| | |
99
| -------------- |---------------------------------------------------------------- |
1010
| *Code* | [GitHub][repo] |
11-
| *Issues* | [Puppet JIRA Tracker][JIRA] |
11+
| *Issues* | [GitHub issues][issues] |
1212
| *License* | [Apache 2.0][LICENSE] |
1313
| *Change log* | [CHANGELOG.md][changelog] |
1414
| *Contributing* | [CONTRIBUTING.md][contributing] and [COMMITTERS.md][committers] |
1515

16-
[repo]: https://github.com/puppetlabs/puppet-strings
17-
[JIRA]: https://tickets.puppetlabs.com/browse/PDOC
18-
[LICENSE]: https://github.com/puppetlabs/puppet-strings/blob/master/LICENSE
19-
[changelog]: https://github.com/puppetlabs/puppet-strings/blob/master/CHANGELOG.md
20-
[contributing]: https://github.com/puppetlabs/puppet-strings/blob/master/CONTRIBUTING.md
21-
[committers]: https://github.com/puppetlabs/puppet-strings/blob/master/COMMITTERS.md
22-
2316
## Installing Puppet Strings
2417

2518
### Requirements
@@ -135,10 +128,22 @@ An example of run the acceptance tests follow the instructions [here].
135128

136129
## Support
137130

138-
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.
131+
Please log issues in [GitHub issues][issues]. Check out [CONTRIBUTING.md][contributing] for tips on writing _the best_ issues.
139132

140-
There is also an active #puppet channel on the Freenode IRC network.
133+
A [mailing list](https://groups.google.com/forum/?fromgroups#!forum/puppet-users) is available for asking questions and getting help from others.
134+
135+
There is also an active community on the [Puppet community Slack][] in the #forge-modules channel.
141136

142137
We use semantic version numbers for our releases and recommend that users upgrade to patch releases and minor releases as they become available.
143138

144139
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.
140+
141+
142+
[repo]: https://github.com/puppetlabs/puppet-strings
143+
[issues]: https://github.com/puppetlabs/puppet-strings/issues
144+
[LICENSE]: https://github.com/puppetlabs/puppet-strings/blob/master/LICENSE
145+
[changelog]: https://github.com/puppetlabs/puppet-strings/blob/master/CHANGELOG.md
146+
[contributing]: https://github.com/puppetlabs/puppet-strings/blob/master/CONTRIBUTING.md
147+
[committers]: https://github.com/puppetlabs/puppet-strings/blob/master/COMMITTERS.md
148+
[Puppet community Slack]: https://slack.puppet.com
149+

0 commit comments

Comments
 (0)