Skip to content

Commit

Permalink
Edit per beauby [ci skip]
Browse files Browse the repository at this point in the history
  • Loading branch information
bf4 committed Oct 16, 2015
1 parent 285dd6d commit 91c5450
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 16 deletions.
28 changes: 14 additions & 14 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,24 +30,24 @@ 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?
- The best help here is a failing test.
- The best help here is a failing test. Even better if it's a PR.
- Then the steps to reproduce and/or a gist or repository that demonstrates the defect.
- Then examples of the code you were using.
- 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 All @@ -103,9 +103,9 @@ ActiveModelSerializers uses a subset of [StandardIssueLabels](https://github.com

## Submitting a pull request (PR)

1. The vast majority of development is happening under the `master` branch, currently slated for release as `0.10.x`.
1. The vast majority of development is happening under the `master` branch.
This is where we would suggest you start.
1. Fixing bugs is extraordinarily helpful and requires the least familiarity with ActiveModelSerializer.
1. Fixing bugs is extraordinarily helpful and requires the least familiarity with ActiveModelSerializers.
Look for issues labeled [**Needs Bug Verification**](https://github.com/rails-api/active_model_serializers/labels/Needs%20Bug%20Verification) and [**Bug**](https://github.com/rails-api/active_model_serializers/labels/bug).
1. Adding or fixing documentation is also fantastic!

Expand All @@ -120,7 +120,7 @@ To fetch & test the library for development, do:
e.g. `export RAILS_VERSION=4.0`.
1. Create your PR branch (`git checkout -b my-helpful-pr`)
1. Write tests for your feature, or regression tests highlighting a bug.
This is important so AcitveModel Serializers doesn't break it in a future version unintentionally.
This is important so ActiveModelSerializers doesn't break it in a future version unintentionally.
1. Write the feature itself, or fix your bug
1. `bundle exec rake`
1. Commit your changes (`git commit -am 'Add some feature'`)
Expand All @@ -138,7 +138,7 @@ To fetch & test the library for development, do:
1. Iterate on feedback given by the community (fix syntax, modify bits of code, add
tests), pushing the new commits to the PR each time

Remember to [squash your commits] and rebase off `master`.
Remember to [squash your commits](#about-pull-requests-prster) and rebase off `master`.

#### How maintainers handle pull requests:

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 91c5450

Please sign in to comment.