Skip to content

Commit 5d9039e

Browse files
committed
Adjust GitHub templates
1 parent 721efff commit 5d9039e

File tree

3 files changed

+93
-45
lines changed

3 files changed

+93
-45
lines changed

.github/ISSUE_TEMPLATE.md

Lines changed: 25 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,25 @@
1-
### Expected behavior and actual behavior.
2-
3-
- What did you expect to happen?
4-
- What happened? Include as much information as possible, such as:
5-
- Nature of reported defect (e.g. user name missing, not "It doesn't work."). Is it intermittent?
6-
- The best help here is a failing test. Even better if it's a PR.
7-
- Then the steps to reproduce and/or a gist or repository that demonstrates the defect.
8-
- Then examples of the code you were using.
9-
- Any error messages (including stacktrace, i.e. "Show me the error.")
10-
11-
### Steps to reproduce the issue (i.e. "Show me how to show myself." )
12-
13-
- What were you doing? Include code if possible, such as:
14-
- Command line parameters used, if any.
15-
- RubyGems code in your Gemfile, if any. Gemfile.lock, if possible.
16-
- Any configuration you've made.
17-
- Things you've tried.
18-
- Link to source code, if available.
19-
20-
### Specifications
21-
22-
- ActiveModelSerializers version (0.8.x, 0.9.x, 0.10.x, commit ref).
23-
- What are you using ActiveModelSerializers with? Rails? Grape? Other? Which versions?
24-
- If you are not running the latest version (please check), and you cannot update it,
25-
please specify in your report why you can't update to the latest version.
26-
- Ruby version with patch level. And whether you're using rvm, rbenv, etc.
27-
- Include `ruby -e "puts RUBY_DESCRIPTION"`.
28-
- Operating system type + version. e.g. Mac OSX Snow Leopard
29-
30-
For more general guidelines, see [Filing an
31-
issue](https://github.com/rails-api/active_model_serializers/blob/master/CONTRIBUTING.md#filing-an-issue).
1+
#### Expected behavior vs actual behavior
2+
<br><br>
3+
4+
#### Steps to reproduce
5+
*(e.g., detailed walkthrough, runnable script, example application)*
6+
<br><br><br>
7+
8+
#### Environment
9+
10+
ActiveModelSerializers Version *(commit ref if not on tag)*:
11+
12+
Output of `ruby -e "puts RUBY_DESCRIPTION"`:
13+
14+
OS Type & Version:
15+
16+
Integrated application and version *(e.g., Rails, Grape, etc)*:
17+
<br><br>
18+
19+
#### Backtrace
20+
*(e.g., provide any applicable backtraces from your application)*
21+
<br><br><br>
22+
23+
#### Additonal helpful information
24+
*(e.g., Gemfile.lock, configurations, PR containing a failing test, git bisect results)*
25+
<br><br><br>

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 10 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,14 @@
1-
### Links to any relevant github issues:
1+
#### Purpose
2+
<br><br>
23

3-
- [Issue description](http://example.com/org/repo/issues/411). Any other useful information.
4+
#### Changes
5+
<br><br>
46

5-
### What's in the the PR
7+
#### Caveats
8+
<br><br>
69

7-
- [ ] A description of the changes proposed in the pull request.
8-
- [ ] Any areas or issues reviewer should pay attention to? (comments in diff okay).
9-
- [ ] Update `/docs` to include, whenever possible, a new, suitable recommendation about how to use
10-
the feature.
11-
- [ ] Extra Credit: [Confirm it runs and tests pass on the Rubies specified in the Travis
12-
config](.travis.yml). A maintainer will otherwise confirm it runs on these.
13-
- [ ] *Bonus Points* Update [CHANGELOG.md](https://github.com/rails-api/active_model_serializers/blob/master/CHANGELOG.md)
14-
with a brief description of any breaking changes, fixes, features, or
15-
miscellaneous changes at the top of the proper version section.
10+
#### Related GitHub issues
11+
<br><br>
1612

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

docs/STYLE.md

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
# STYLE
2+
3+
## Code and comments
4+
5+
- We are actively working to identify tasks under the label [**Good for New
6+
Contributors**](https://github.com/rails-api/active_model_serializers/labels/Good%20for%20New%20Contributors).
7+
- [Changelog
8+
Missing](https://github.com/rails-api/active_model_serializers/issues?q=label%3A%22Changelog+Missing%22+is%3Aclosed) is
9+
an easy way to help out.
10+
11+
- [Fix a bug](https://github.com/rails-api/active_model_serializers/labels/Ready%20for%20PR).
12+
- Ready for PR - A well defined bug, needs someone to PR a fix.
13+
- Bug - Anything that is broken.
14+
- Regression - A bug that did not exist in previous versions and isn't a new feature (applied in tandem with Bug).
15+
- Performance - A performance related issue. We could track this as a bug, but usually these would have slightly lower priority than standard bugs.
16+
17+
- [Develop new features](https://github.com/rails-api/active_model_serializers/labels/Feature).
18+
19+
- [Improve code quality](https://codeclimate.com/github/rails-api/active_model_serializers/code?sort=smell_count&sort_direction=desc).
20+
21+
- [Improve amount of code exercised by tests](https://codeclimate.com/github/rails-api/active_model_serializers/coverage?sort=covered_percent&sort_direction=asc).
22+
23+
- [Fix RuboCop (Style) TODOS](https://github.com/rails-api/active_model_serializers/blob/master/.rubocop_todo.yml).
24+
- Delete and offsense, run `rake rubocop` (or possibly `rake rubocop:auto_correct`),
25+
and [submit a PR](CONTRIBUTING.md#submitting-a-pull-request-pr).
26+
27+
- We are also encouraging comments to substantial changes (larger than bugfixes and simple features) under an
28+
"RFC" (Request for Comments) process before we start active development.
29+
Look for the [**RFC**](https://github.com/rails-api/active_model_serializers/labels/RFC) label.
30+
31+
32+
## Pull requests
33+
34+
- If the tests pass and the pull request looks good, a maintainer will merge it.
35+
- If the pull request needs to be changed,
36+
- you can change it by updating the branch you generated the pull request from
37+
- either by adding more commits, or
38+
- by force pushing to it
39+
- A maintainer can make any changes themselves and manually merge the code in.
40+
41+
## Commit messages
42+
43+
- [A Note About Git Commit Messages](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)
44+
- [http://stopwritingramblingcommitmessages.com/](http://stopwritingramblingcommitmessages.com/)
45+
- [ThoughtBot style guide](https://github.com/thoughtbot/guides/tree/master/style#git)
46+
47+
#### About Pull Requests (PR's)
48+
49+
- [Using Pull Requests](https://help.github.com/articles/using-pull-requests)
50+
- [Github pull requests made easy](http://www.element84.com/github-pull-requests-made-easy.html)
51+
- [Exercism Git Workflow](http://help.exercism.io/git-workflow.html).
52+
- [Level up your Git](http://rakeroutes.com/blog/deliberate-git/)
53+
- [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/)
54+
55+
## Issue Labeling
56+
57+
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).
58+

0 commit comments

Comments
 (0)