From fcf5f8caba1d374f8146cbdc79f01c4f11cb6d5e Mon Sep 17 00:00:00 2001 From: Benjamin Fleischer Date: Wed, 21 Oct 2015 15:43:28 -0500 Subject: [PATCH] Edits per joaomdmoura [ci skip] --- CONTRIBUTING.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index fd793268..8943bd2c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -11,7 +11,7 @@ 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 them: -bugs, ideas, documentation, performance problems – everything helps! +bugs, ideas, documentation (`/docs`), performance problems – everything helps! #### Before @@ -56,8 +56,6 @@ Simon Tatham has written an excellent on article on [How to Report Bugs Effectively](http://www.chiark.greenend.org.uk/~sgtatham/bugs.html) which is well worth reading, although it is not specific to ActiveModelSerializers. - - 1. What have you tried? 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.) @@ -129,6 +127,8 @@ To fetch & test the library for development, do: 1. Create a new Pull Request - Include links to any relevant github issues. - *Don't* change the VERSION file. + - Update `/docs` to include, whenever possible, a new, suitable recommendation about how to use + the feature. - Extra Credit: [Confirm it runs and tests pass on the rubies specified in the travis config](.travis.yml). A maintainer will otherwise confirm it runs on these.