Skip to content

Commit

Permalink
Edit per beauby
Browse files Browse the repository at this point in the history
  • Loading branch information
bf4 committed Oct 15, 2015
1 parent 285dd6d commit ab1504b
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 11 deletions.
18 changes: 9 additions & 9 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,14 @@ http://www.commitstrip.com/en/2014/05/07/the-truth-behind-open-source-apps/](doc

### Filing an issue

Everyone is encouraged to open issues that are affecting you:
Everyone is encouraged to open issues that are affecting them:
bugs, ideas, documentation, performance problems – everything helps!

#### Before

1. The first place to start is by looking at our [GitHub Issues](https://github.com/rails-api/active_model_serializers/issues).
1. Start by looking at our [GitHub Issues](https://github.com/rails-api/active_model_serializers/issues).

- Check if your issue has already reported.
- Check if your issue has already been reported.
- If you find an existing issue report, feel free to add further information to that report.


Expand All @@ -30,14 +30,14 @@ issue](https://github.com/rails-api/active_model_serializers/issues/new):
- What are you using ActiveModelSerializers with? Rails? Grape? Other? Which versions?
- If you are not running the latest version (please check), and you cannot update it,
please specify in your report why you can't update to the latest version.
- Operating system type + version
- Ruby version with patch level. And if you're using rvm, rbenv, etc.
- Operating system type + version.
- Ruby version with patch level. And whether you're using rvm, rbenv, etc.
- Include your ruby -e "puts RUBY_DESCRIPTION".
- Clearly-written steps to reproduce the issue (i.e. "Show me how to show myself." ), including:
- What were you doing? Include code if possible.
- Command line parameters used, if any.
- RubyGems code in your Gemfile, if any. Gemfile.lock, if possible
- Any configuration you've made
- RubyGems code in your Gemfile, if any. Gemfile.lock, if possible.
- Any configuration you've made.
- What did you expect to happen?
- What happened? Include as much information as possible.
- Nature of reported defect (e.g. user name missing, not "It doesn't work."). Is it intermittent?
Expand All @@ -47,7 +47,7 @@ issue](https://github.com/rails-api/active_model_serializers/issues/new):
- Any error messages (including stacktrace, i.e. ""Show me the error.")
- Things you've tried.
- A pull request for your fix would be great. Code should have tests.
- Link to source code, if available
- Link to source code, if available.

Please make sure only to include one issue per report.
If you encounter multiple, unrelated issues, please report them as such.
Expand Down Expand Up @@ -79,7 +79,7 @@ what you've found is *extremely* helpful.

If you solve your issue, stop working on it, or realize the problem was something else,
please share that in a comment to an issue and close it. That way, everyone can learn and
we don't have closing issues without a clear resolution. Even if it's just a stackoverflow link :)
we don't have closed issues without a clear resolution. Even if it's just a stackoverflow link :)
And please don't forget to stay involved in the issue until it is closed! Thanks to all!

### Writing code and comments
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# ActiveModel::Serializer
# ActiveModelSerializers

[![Build Status](https://travis-ci.org/rails-api/active_model_serializers.svg?branch=master)](https://travis-ci.org/rails-api/active_model_serializers)
<a href="https://codeclimate.com/github/rails-api/active_model_serializers"><img src="https://codeclimate.com/github/rails-api/active_model_serializers/badges/gpa.svg" /></a>
<a href="https://codeclimate.com/github/rails-api/active_model_serializers/coverage"><img src="https://codeclimate.com/github/rails-api/active_model_serializers/badges/coverage.svg" /></a>

_Windows Build Status -_ [![Build status](https://ci.appveyor.com/api/projects/status/x6xdjydutm54gvyt/branch/master?svg=true)](https://ci.appveyor.com/project/joaomdmoura/active-model-serializers/branch/master)

ActiveModel::Serializer brings convention over configuration to your JSON generation.
ActiveModelSerializers brings convention over configuration to your JSON generation.

AMS does this through two components: **serializers** and **adapters**.
Serializers describe _which_ attributes and relationships should be serialized.
Expand Down

0 comments on commit ab1504b

Please sign in to comment.