From 5d9039e1720977889612240da1229d344033d466 Mon Sep 17 00:00:00 2001 From: Ben Mills Date: Fri, 26 Feb 2016 09:54:44 -0700 Subject: [PATCH] Adjust GitHub templates --- .github/ISSUE_TEMPLATE.md | 44 +++++++++++------------- .github/PULL_REQUEST_TEMPLATE.md | 24 ++++++------- docs/STYLE.md | 58 ++++++++++++++++++++++++++++++++ 3 files changed, 87 insertions(+), 39 deletions(-) create mode 100644 docs/STYLE.md diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index 1e123a84..687ec2d3 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -1,31 +1,25 @@ -### Expected behavior and actual behavior. +#### Expected behavior vs actual behavior +

-- What did you expect to happen? -- What happened? Include as much information as possible, such as: - - 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. 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.") +#### Steps to reproduce +*(e.g., detailed walkthrough, runnable script, example application)* +


-### Steps to reproduce the issue (i.e. "Show me how to show myself." ) +#### Environment -- What were you doing? Include code if possible, such as: - - Command line parameters used, if any. - - RubyGems code in your Gemfile, if any. Gemfile.lock, if possible. - - Any configuration you've made. -- Things you've tried. -- Link to source code, if available. +ActiveModelSerializers Version *(commit ref if not on tag)*: -### Specifications +Output of `ruby -e "puts RUBY_DESCRIPTION"`: -- ActiveModelSerializers version (0.8.x, 0.9.x, 0.10.x, commit ref). -- 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. -- Ruby version with patch level. And whether you're using rvm, rbenv, etc. - - Include `ruby -e "puts RUBY_DESCRIPTION"`. -- Operating system type + version. e.g. Mac OSX Snow Leopard +OS Type & Version: -For more general guidelines, see [Filing an -issue](https://github.com/rails-api/active_model_serializers/blob/master/CONTRIBUTING.md#filing-an-issue). +Integrated application and version *(e.g., Rails, Grape, etc)*: +

+ +#### Backtrace +*(e.g., provide any applicable backtraces from your application)* +


+ +#### Additonal helpful information +*(e.g., Gemfile.lock, configurations, PR containing a failing test, git bisect results)* +


diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 5aac02e5..951ffcea 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,18 +1,14 @@ -### Links to any relevant github issues: +#### Purpose +

-- [Issue description](http://example.com/org/repo/issues/411). Any other useful information. +#### Changes +

-### What's in the the PR +#### Caveats +

-- [ ] A description of the changes proposed in the pull request. - - [ ] Any areas or issues reviewer should pay attention to? (comments in diff okay). -- [ ] 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. -- [ ] *Bonus Points* Update [CHANGELOG.md](https://github.com/rails-api/active_model_serializers/blob/master/CHANGELOG.md) - with a brief description of any breaking changes, fixes, features, or - miscellaneous changes at the top of the proper version section. +#### Related GitHub issues +

-For more general information, see [Submitting a pull request]( -https://github.com/rails-api/active_model_serializers/blob/master/CONTRIBUTING.md#submitting-a-pull-request-pr). +#### Additonal helpful information +

diff --git a/docs/STYLE.md b/docs/STYLE.md new file mode 100644 index 00000000..ccd75dd4 --- /dev/null +++ b/docs/STYLE.md @@ -0,0 +1,58 @@ +# STYLE + +## Code and comments + +- We are actively working to identify tasks under the label [**Good for New + Contributors**](https://github.com/rails-api/active_model_serializers/labels/Good%20for%20New%20Contributors). + - [Changelog + Missing](https://github.com/rails-api/active_model_serializers/issues?q=label%3A%22Changelog+Missing%22+is%3Aclosed) is + an easy way to help out. + +- [Fix a bug](https://github.com/rails-api/active_model_serializers/labels/Ready%20for%20PR). + - Ready for PR - A well defined bug, needs someone to PR a fix. + - Bug - Anything that is broken. + - Regression - A bug that did not exist in previous versions and isn't a new feature (applied in tandem with Bug). + - Performance - A performance related issue. We could track this as a bug, but usually these would have slightly lower priority than standard bugs. + +- [Develop new features](https://github.com/rails-api/active_model_serializers/labels/Feature). + +- [Improve code quality](https://codeclimate.com/github/rails-api/active_model_serializers/code?sort=smell_count&sort_direction=desc). + +- [Improve amount of code exercised by tests](https://codeclimate.com/github/rails-api/active_model_serializers/coverage?sort=covered_percent&sort_direction=asc). + +- [Fix RuboCop (Style) TODOS](https://github.com/rails-api/active_model_serializers/blob/master/.rubocop_todo.yml). + - Delete and offsense, run `rake rubocop` (or possibly `rake rubocop:auto_correct`), + and [submit a PR](CONTRIBUTING.md#submitting-a-pull-request-pr). + +- We are also encouraging comments to substantial changes (larger than bugfixes and simple features) under an + "RFC" (Request for Comments) process before we start active development. + Look for the [**RFC**](https://github.com/rails-api/active_model_serializers/labels/RFC) label. + + +## Pull requests + +- If the tests pass and the pull request looks good, a maintainer will merge it. +- If the pull request needs to be changed, + - you can change it by updating the branch you generated the pull request from + - either by adding more commits, or + - by force pushing to it + - A maintainer can make any changes themselves and manually merge the code in. + +## Commit messages + +- [A Note About Git Commit Messages](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html) +- [http://stopwritingramblingcommitmessages.com/](http://stopwritingramblingcommitmessages.com/) +- [ThoughtBot style guide](https://github.com/thoughtbot/guides/tree/master/style#git) + +#### About Pull Requests (PR's) + +- [Using Pull Requests](https://help.github.com/articles/using-pull-requests) +- [Github pull requests made easy](http://www.element84.com/github-pull-requests-made-easy.html) +- [Exercism Git Workflow](http://help.exercism.io/git-workflow.html). +- [Level up your Git](http://rakeroutes.com/blog/deliberate-git/) +- [All Your Open Source Code Are Belong To Us](http://www.benjaminfleischer.com/2013/07/30/all-your-open-source-code-are-belong-to-us/) + +## Issue Labeling + +ActiveModelSerializers uses a subset of [StandardIssueLabels](https://github.com/wagenet/StandardIssueLabels) for Github Issues. You can [see our labels here](https://github.com/rails-api/active_model_serializers/labels). +