Skip to content

Commit

Permalink
Add notes to contributing around issues
Browse files Browse the repository at this point in the history
  • Loading branch information
durran committed Jul 25, 2012
1 parent 2c09b83 commit f87c93c
Showing 1 changed file with 37 additions and 0 deletions.
37 changes: 37 additions & 0 deletions en/mongoid/docs/contributing.html
Original file line number Original file line Diff line number Diff line change
Expand Up @@ -89,11 +89,48 @@ <h1>Contributing</h1>
<div class='page-nav'> <div class='page-nav'>
<div class='container'> <div class='container'>
<ul class='nav nav-pills'> <ul class='nav nav-pills'>
<li><a href="#issues">Issues</a></li>
<li><a href="#core">Core</a></li> <li><a href="#core">Core</a></li>
<li><a href="#documentation">Docs</a></li> <li><a href="#documentation">Docs</a></li>
</ul> </ul>
</div> </div>
</div> </div>
<section id='issues'>
<h2>Issues</h2>
<p>
As developers, we hate getting issue reports from users that we cannot
replicate don't we? The same applies when submitting issues as well. Here
are some guidelines on what to provide in a Github issue in order for us
to expedite resolving the problem.
</p>
<ul>
<li>
The version of Mongoid (and if applicable Moped and Origin) that you are
using. We cannot assume a particular version since we actively support
and maintain 10-20 patch releases and 2 major releases at the same time.
</li>
<li>
Your operating system and version. Yes, this is important, especially from
a database driver perspective.
</li>
<li>
Your Ruby version, with exact patch level. This is also very important
for the same reasons as above.
</li>
<li>
If you are getting a stack trace, please provide the <i>entire thing</i>, not
just the message or the last line in it. Stack traces provide context
and omitting them for the sake of brevity is not helpful.
</li>
<li>
The exact steps in your application to reproduce the error, or some code
that will reproduce the issue without need for interperetation from our side.
This is very important as we are not mind readers and cannot make any
assumptions about how the issue arose. The more information you provide,
the faster we can address it.
</li>
</ul>
</section>
<section id='core'> <section id='core'>
<h2>Core Contributions</h2> <h2>Core Contributions</h2>
<p> <p>
Expand Down

0 comments on commit f87c93c

Please sign in to comment.