mirror of
https://github.com/ditkrg/active_model_serializers.git
synced 2026-01-22 22:06:50 +00:00
186 lines
5.8 KiB
HTML
186 lines
5.8 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
|
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
|
|
<title>
|
|
File: STYLE
|
|
|
|
— Documentation by YARD 0.8.7.6
|
|
|
|
</title>
|
|
|
|
<link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
|
|
|
|
<link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
|
|
|
|
<script type="text/javascript" charset="utf-8">
|
|
hasFrames = window.top.frames.main ? true : false;
|
|
relpath = '';
|
|
framesUrl = "frames.html#!file.STYLE.html";
|
|
</script>
|
|
|
|
|
|
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
|
|
|
|
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
|
|
|
|
|
|
</head>
|
|
<body>
|
|
<div id="header">
|
|
<div id="menu">
|
|
|
|
<a href="_index.html">Index</a> »
|
|
<span class="title">File: STYLE</span>
|
|
|
|
|
|
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
|
|
</div>
|
|
|
|
<div id="search">
|
|
|
|
<a class="full_list_link" id="class_list_link"
|
|
href="class_list.html">
|
|
Class List
|
|
</a>
|
|
|
|
<a class="full_list_link" id="method_list_link"
|
|
href="method_list.html">
|
|
Method List
|
|
</a>
|
|
|
|
<a class="full_list_link" id="file_list_link"
|
|
href="file_list.html">
|
|
File List
|
|
</a>
|
|
|
|
</div>
|
|
<div class="clear"></div>
|
|
</div>
|
|
|
|
<iframe id="search_frame"></iframe>
|
|
|
|
<div id="content"><div id='filecontents'>
|
|
<h1 id="label-STYLE">STYLE</h1>
|
|
|
|
<h2 id="label-Code+and+comments">Code and comments</h2>
|
|
<ul><li>
|
|
<p>We are actively working to identify tasks under the label <a
|
|
href="https://github.com/rails-api/active_model_serializers/labels/Good%20for%20New%20Contributors">Good
|
|
for New Contributors</a>.</p>
|
|
</li><li>
|
|
<p><a
|
|
href="https://github.com/rails-api/active_model_serializers/issues?q=label%3A%22Changelog+Missing%22+is%3Aclosed">Changelog
|
|
Missing</a> is an easy way to help out.</p>
|
|
</li><li>
|
|
<p><a
|
|
href="https://github.com/rails-api/active_model_serializers/labels/Ready%20for%20PR">Fix
|
|
a bug</a>.</p>
|
|
</li><li>
|
|
<p>Ready for PR - A well defined bug, needs someone to PR a fix.</p>
|
|
</li><li>
|
|
<p>Bug - Anything that is broken.</p>
|
|
</li><li>
|
|
<p>Regression - A bug that did not exist in previous versions and isn't a
|
|
new feature (applied in tandem with Bug).</p>
|
|
</li><li>
|
|
<p>Performance - A performance related issue. We could track this as a bug,
|
|
but usually these would have slightly lower priority than standard bugs.</p>
|
|
</li><li>
|
|
<p><a
|
|
href="https://github.com/rails-api/active_model_serializers/labels/Feature">Develop
|
|
new features</a>.</p>
|
|
</li><li>
|
|
<p><a
|
|
href="https://codeclimate.com/github/rails-api/active_model_serializers/code?sort=smell_count&sort_direction=desc">Improve
|
|
code quality</a>.</p>
|
|
</li><li>
|
|
<p><a
|
|
href="https://codeclimate.com/github/rails-api/active_model_serializers/coverage?sort=covered_percent&sort_direction=asc">Improve
|
|
amount of code exercised by tests</a>.</p>
|
|
</li><li>
|
|
<p><a
|
|
href="https://github.com/rails-api/active_model_serializers/blob/master/.rubocop_todo.yml">Fix
|
|
RuboCop (Style) TODOS</a>.</p>
|
|
</li><li>
|
|
<p>Delete and offsense, run <code>rake rubocop</code> (or possibly <code>rake
|
|
rubocop:auto_correct</code>), and <a
|
|
href="CONTRIBUTING.md#submitting-a-pull-request-pr">submit a PR</a>.</p>
|
|
</li><li>
|
|
<p>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 <a
|
|
href="https://github.com/rails-api/active_model_serializers/labels/RFC">RFC</a>
|
|
label.</p>
|
|
</li></ul>
|
|
|
|
<h2 id="label-Pull+requests">Pull requests</h2>
|
|
<ul><li>
|
|
<p>If the tests pass and the pull request looks good, a maintainer will merge
|
|
it.</p>
|
|
</li><li>
|
|
<p>If the pull request needs to be changed,</p>
|
|
</li><li>
|
|
<p>you can change it by updating the branch you generated the pull request
|
|
from</p>
|
|
<ul><li>
|
|
<p>either by adding more commits, or</p>
|
|
</li><li>
|
|
<p>by force pushing to it</p>
|
|
</li></ul>
|
|
</li><li>
|
|
<p>A maintainer can make any changes themselves and manually merge the code
|
|
in.</p>
|
|
</li></ul>
|
|
|
|
<h2 id="label-Commit+messages">Commit messages</h2>
|
|
<ul><li>
|
|
<p><a
|
|
href="http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html">A
|
|
Note About Git Commit Messages</a></p>
|
|
</li><li>
|
|
<p><a
|
|
href="http://stopwritingramblingcommitmessages.com/">stopwritingramblingcommitmessages.com/</a></p>
|
|
</li><li>
|
|
<p><a
|
|
href="https://github.com/thoughtbot/guides/tree/master/style#git">ThoughtBot
|
|
style guide</a></p>
|
|
</li></ul>
|
|
|
|
<h4 id="label-About+Pull+Requests+-28PR-27s-29">About Pull Requests (PR's)</h4>
|
|
<ul><li>
|
|
<p><a href="https://help.github.com/articles/using-pull-requests">Using Pull
|
|
Requests</a></p>
|
|
</li><li>
|
|
<p><a
|
|
href="http://www.element84.com/github-pull-requests-made-easy.html">Github
|
|
pull requests made easy</a></p>
|
|
</li><li>
|
|
<p><a href="http://help.exercism.io/git-workflow.html">Exercism Git
|
|
Workflow</a>.</p>
|
|
</li><li>
|
|
<p><a href="http://rakeroutes.com/blog/deliberate-git/">Level up your Git</a></p>
|
|
</li><li>
|
|
<p><a
|
|
href="http://www.benjaminfleischer.com/2013/07/30/all-your-open-source-code-are-belong-to-us/">All
|
|
Your Open Source Code Are Belong To Us</a></p>
|
|
</li></ul>
|
|
|
|
<h2 id="label-Issue+Labeling">Issue Labeling</h2>
|
|
|
|
<p>ActiveModelSerializers uses a subset of <a
|
|
href="https://github.com/wagenet/StandardIssueLabels">StandardIssueLabels</a>
|
|
for Github Issues. You can <a
|
|
href="https://github.com/rails-api/active_model_serializers/labels">see our
|
|
labels here</a>.</p>
|
|
</div></div>
|
|
|
|
<div id="footer">
|
|
Generated on Thu Jun 16 09:05:03 2016 by
|
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
0.8.7.6 (ruby-2.2.4).
|
|
</div>
|
|
|
|
</body>
|
|
</html> |