Skip to content

Commit 310c754

Browse files
committed
Simplify CONTRIBUTING.md for filling an issue
1 parent f5ec8ed commit 310c754

File tree

1 file changed

+2
-30
lines changed

1 file changed

+2
-30
lines changed

CONTRIBUTING.md

Lines changed: 2 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -32,44 +32,16 @@ issue](https://github.com/rails-api/active_model_serializers/issues/new):
3232

3333
- ActiveModelSerializers version (0.8.x, 0.9.x, 0.10.x, commit ref).
3434
- What are you using ActiveModelSerializers with? Rails? Grape? Other? Which versions?
35-
- If you are not running the latest version (please check), and you cannot update it,
36-
please specify in your report why you can't update to the latest version.
3735
- Operating system type + version.
38-
- Ruby version with patch level. And whether you're using rvm, rbenv, etc.
39-
- Include `ruby -e "puts RUBY_DESCRIPTION"`.
40-
- Clearly-written steps to reproduce the issue (i.e. "Show me how to show myself." ), including:
41-
- What were you doing? Include code if possible.
42-
- Command line parameters used, if any.
43-
- RubyGems code in your Gemfile, if any. Gemfile.lock, if possible.
44-
- Any configuration you've made.
45-
- What did you expect to happen?
46-
- What happened? Include as much information as possible.
47-
- Nature of reported defect (e.g. user name missing, not "It doesn't work."). Is it intermittent?
48-
- The best help here is a failing test. Even better if it's a PR.
49-
- Then the steps to reproduce and/or a gist or repository that demonstrates the defect.
50-
- Then examples of the code you were using.
51-
- Any error messages (including stacktrace, i.e. "Show me the error.")
52-
- Things you've tried.
53-
- A pull request for your fix would be great. Code should have tests.
54-
- Link to source code, if available.
55-
56-
Please make sure only to include one issue per report.
57-
If you encounter multiple, unrelated issues, please report them as such.
36+
- Ruby version: `ruby -e "puts RUBY_DESCRIPTION"`.
37+
- Steps to reproduce the issue (i.e. "Show me how to show myself." ). What did you expect to happen? What happened? What did you try?
5838

5939
Simon Tatham has written an excellent on article on
6040
[How to Report Bugs Effectively](http://www.chiark.greenend.org.uk/~sgtatham/bugs.html)
6141
which is [well worth reading](http://yourbugreportneedsmore.info/), although it is not specific to ActiveModelSerializers.
6242

63-
Include as much sample code as you can to help us reproduce the issue. (Inline, repo link, or gist, are fine. A failing test would help the most.)
64-
65-
This is extremely important for narrowing down the cause of your problem.
66-
6743
Thanks!
6844

69-
Sometimes an issue will be closed by a maintainer for various reasons. In some cases, this is
70-
an invitation to make a better case for your issue or be able to reproduce a bug, and
71-
its being close is just an opportunity to help out some more, and then re-open.
72-
7345
#### After
7446

7547
Thanks to everyone involved!

0 commit comments

Comments
 (0)