Skip to content

Commit ee52127

Browse files
committed
(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.
1 parent e4ea492 commit ee52127

File tree

2 files changed

+35
-1
lines changed

2 files changed

+35
-1
lines changed

CONTRIBUTING.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,38 @@ that we can have a chance of keeping on top of things.
1414
* Make sure you fill in the earliest version that you know has the issue.
1515
* Fork the repository on GitHub
1616

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

1951
* Create a topic branch from where you want to base your work.

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,9 @@ An example of run the acceptance tests follow the instructions [here].
135135

136136
## Support
137137

138-
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.
138+
Please log issues in [GitHub issues][issues]. Check out [CONTRIBUTING.md][contributing] for tips on writing _the best_ issues.
139+
140+
A [mailing list](https://groups.google.com/forum/?fromgroups#!forum/puppet-users) is available for asking questions and getting help from others.
139141

140142
There is also an active #puppet channel on the Freenode IRC network.
141143

0 commit comments

Comments
 (0)