Skip to content

Commit 8c52c36

Browse files
committed
Edit per beauby [ci skip]
1 parent 285dd6d commit 8c52c36

File tree

2 files changed

+16
-16
lines changed

2 files changed

+16
-16
lines changed

CONTRIBUTING.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,14 @@ http://www.commitstrip.com/en/2014/05/07/the-truth-behind-open-source-apps/](doc
1010

1111
### Filing an issue
1212

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

1616
#### Before
1717

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

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

2323

@@ -30,24 +30,24 @@ issue](https://github.com/rails-api/active_model_serializers/issues/new):
3030
- What are you using ActiveModelSerializers with? Rails? Grape? Other? Which versions?
3131
- If you are not running the latest version (please check), and you cannot update it,
3232
please specify in your report why you can't update to the latest version.
33-
- Operating system type + version
34-
- Ruby version with patch level. And if you're using rvm, rbenv, etc.
33+
- Operating system type + version.
34+
- Ruby version with patch level. And whether you're using rvm, rbenv, etc.
3535
- Include your ruby -e "puts RUBY_DESCRIPTION".
3636
- Clearly-written steps to reproduce the issue (i.e. "Show me how to show myself." ), including:
3737
- What were you doing? Include code if possible.
3838
- Command line parameters used, if any.
39-
- RubyGems code in your Gemfile, if any. Gemfile.lock, if possible
40-
- Any configuration you've made
39+
- RubyGems code in your Gemfile, if any. Gemfile.lock, if possible.
40+
- Any configuration you've made.
4141
- What did you expect to happen?
4242
- What happened? Include as much information as possible.
4343
- Nature of reported defect (e.g. user name missing, not "It doesn't work."). Is it intermittent?
44-
- The best help here is a failing test.
44+
- The best help here is a failing test. Even better if it's a PR.
4545
- Then the steps to reproduce and/or a gist or repository that demonstrates the defect.
4646
- Then examples of the code you were using.
4747
- Any error messages (including stacktrace, i.e. ""Show me the error.")
4848
- Things you've tried.
4949
- A pull request for your fix would be great. Code should have tests.
50-
- Link to source code, if available
50+
- Link to source code, if available.
5151

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

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

8585
### Writing code and comments
@@ -103,9 +103,9 @@ ActiveModelSerializers uses a subset of [StandardIssueLabels](https://github.com
103103

104104
## Submitting a pull request (PR)
105105

106-
1. The vast majority of development is happening under the `master` branch, currently slated for release as `0.10.x`.
106+
1. The vast majority of development is happening under the `master` branch.
107107
This is where we would suggest you start.
108-
1. Fixing bugs is extraordinarily helpful and requires the least familiarity with ActiveModelSerializer.
108+
1. Fixing bugs is extraordinarily helpful and requires the least familiarity with ActiveModelSerializers.
109109
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).
110110
1. Adding or fixing documentation is also fantastic!
111111

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

141-
Remember to [squash your commits] and rebase off `master`.
141+
Remember to [squash your commits](CONTRIBUTING.md#about-pull-requests-prs) and rebase off `master`.
142142

143143
#### How maintainers handle pull requests:
144144

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
# ActiveModel::Serializer
1+
# ActiveModelSerializers
22

33
[![Build Status](https://travis-ci.org/rails-api/active_model_serializers.svg?branch=master)](https://travis-ci.org/rails-api/active_model_serializers)
44
<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>
55
<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>
66

77
_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)
88

9-
ActiveModel::Serializer brings convention over configuration to your JSON generation.
9+
ActiveModelSerializers brings convention over configuration to your JSON generation.
1010

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

0 commit comments

Comments
 (0)