Add CONTRIBUTING.md #292
Merged
Add CONTRIBUTING.md #292
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| [gem]: https://rubygems.org/gems/jbuilder | ||
| [codeclimate]: https://codeclimate.com/github/rails/jbuilder | ||
| [gemnasium]: https://gemnasium.com/rails/jbuilder | ||
|
|
There was a problem hiding this comment.
Not sure I'm fully onboard with removing badges from README. What's the rationale behind this?
There was a problem hiding this comment.
Mainly because they are not useful for the final users.
- Travis badge don't add anything since we expect the build to be always green.
- Rubygems badge only give the last release, they can get the same information form GItHub release page.
- Codeclimate badge I don't even think codeclimate is useful, but even if it is gem users don't need to care about it
- Gemnasium it has useful informations only for contributors.
So, IMHO all badges are not useful for the users of the library but they may be useful for contributors so I think it belongs to the CONTRIBUTING.md file.
There was a problem hiding this comment.
Also lostisland/faraday@ac1b537 contains good reasons.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
cc @rafaelfranca