Skip to content

Commit

Permalink
Add paragraphs describing APEs
Browse files Browse the repository at this point in the history
closes #27
  • Loading branch information
eteq committed May 7, 2014
1 parent e189b7e commit 3824ea4
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions contribute.html
Original file line number Diff line number Diff line change
Expand Up @@ -69,8 +69,11 @@ <h2>Contribute feedback</h2>
<h2>Contribute code or documentation</h2>

<p>If you are interested in contributing fixes, code or documentation to Astropy (whether the core package or affiliated packages), you should join the <a href="http://groups.google.com/group/astropy-dev">astropy-dev</a> mailing list/forum, and start looking at any related <a href="https://github.com/astropy/astropy/issues">issues</a>. You may also want to familiarize yourself with the <a href="http://docs.astropy.org/en/latest/#developer-documentation" target="_blank">developer documentation</a>, particularly the <a href="http://docs.astropy.org/en/latest/development/codeguide.html">coding</a> and <a href="http://docs.astropy.org/en/latest/development/docguide.html">documentation</a> guidelines.</p>

<p> Once you have a change to propose, if it's a simple fix to just a single file, you can even just browse to the appropriate file and use the "edit" button on github. If it's a more complex change, we suggest you follow the <a target="_blank" href="index.html#dev">developer install instructions</a>, and use that with <a href="https://github.com/astropy/astropy">Astropy's github page</a> to issue a pull request with your changes. If you aren't familiar with github, we suggest you looking over our <a href="http://astropy.readthedocs.org/en/latest/development/workflow/index.html">workflow documentation</a>. Once your code is accepted, you are officially an Astropy contributor and eligible to be included on the author list of future publications. </p>

<p> If you want to propose a larger change to Astropy, there's a procedure for that: <a href="https://github.com/astropy/astropy-APEs">Astropy Proposals for Enhancement (APEs)</a>, modeled after Python's <a href="http://legacy.python.org/dev/peps/">PEPs</a>. The sort of changes that APEs are intended for include plans for new sub-packages, wide-ranging code re-organizations, a new procedure needing review by a lot of the Astropy community, or an informational document on some decision for Astropy that you want remembered. For more background in APEs, check out <a href="https://github.com/astropy/astropy-APEs/blob/master/APE1.rst">APE #1</a>. To propose a new APE, the procedure is to just copy the template, fill it out, and issue a pull request at the <a href="https://github.com/astropy/astropy-APEs"> astropy-APE repository on github</a>. </p>


</section>

Expand Down

0 comments on commit 3824ea4

Please sign in to comment.