forked from astropy/astropy.github.com
-
Notifications
You must be signed in to change notification settings - Fork 0
/
contribute.html
executable file
·107 lines (79 loc) · 6.72 KB
/
contribute.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="description" content="Astropy. A Community Python Library for Astronomy." />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<link rel="shortcut icon" href="favicon.ico" />
<link href='http://fonts.googleapis.com/css?family=Open+Sans:400italic,400,700' rel='stylesheet' type='text/css' />
<link rel="stylesheet" type="text/css" href="css/style.css" />
<link rel="stylesheet" type="text/css" href="css/jquery.sidr.light.css" />
<title>Astropy | Contribute</title>
</head>
<body>
<div id="wrapper">
<nav>
<div id="mobile-header">
<!-- Menu Icon -->
<a id="responsive-menu-button" href="#sidr-main"><div><svg senable-background="new 0 0 24 24" height="24px" id="Layer_1" version="1.1" viewBox="0 0 24 24" width="24px" x="0px" xml:space="preserve" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" y="0px"><g><g><path d="M23.244,17.009H0.75c-0.413,0-0.75,0.36-0.75,0.801v3.421C0,21.654,0.337,22,0.75,22h22.494c0.414,0,0.75-0.346,0.75-0.77 V17.81C23.994,17.369,23.658,17.009,23.244,17.009z M23.244,9.009H0.75C0.337,9.009,0,9.369,0,9.81v3.421 c0,0.424,0.337,0.769,0.75,0.769h22.494c0.414,0,0.75-0.345,0.75-0.769V9.81C23.994,9.369,23.658,9.009,23.244,9.009z M23.244,1.009H0.75C0.337,1.009,0,1.369,0,1.81V5.23c0,0.423,0.337,0.769,0.75,0.769h22.494c0.414,0,0.75-0.346,0.75-0.769V1.81 C23.994,1.369,23.658,1.009,23.244,1.009z"/></g></g></svg></div></a>
<!-- -->
</div>
<a href="index.html"><img src="images/astropy_word_32.png"/></a>
<div id="navigation">
<ul>
<li><a href="about.html">About</a></li>
<li><a href="help.html">Get Help</a></li>
<li><a class="active" href="contribute.html">Contribute</a></li>
<!-- <li><a href="http://docs.astropy.org" target="_blank">Documentation</a></li> -->
<li><a href="affiliated/index.html">Affiliated Packages</a></li>
</ul>
</div>
<div class="search pull-right">
<form action="http://docs.astropy.org/en/stable/search.html" method="get">
<input type="text" name="q" placeholder="Search Documentation" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</nav>
<section>
<h1>Contribute to Astropy</h1>
<p>The Astropy project is made both by and for its users, so we accept contributions of many kinds. We always welcome contributors who will abide by the <a href="http://www.python.org/psf/codeofconduct/">Python Software Foundation Code of Conduct</a>.</p>
</section>
<section id="feedback">
<h2>Contribute feedback</h2>
<p>There are several ways in which you can give us feedback. </p>
<ul>
<li>If you would like to give us feedback and participate in discussions, we encourage you to join the <a href="http://mail.scipy.org/mailman/listinfo/astropy"> astropy mailing list </a> and post there. This is the easiest way to have a discussion with both developers and other users. </li>
<li>If you have feedback you would prefer to keep private, you can e-mail <a href="mailto:astropy-feedback@googlegroups.com">astropy-feedback@googlegroups.com</a>. This address points to a private mailing list that includes the astropy core developers. If you would like a reply (e.g., an acknowledgement of your comment), please request it.</li>
<li>For the extremely impatient, astropy developers often hang out in the <a target="_blank" href="http://webchat.freenode.net?channels=astropy">#astropy freenode.net IRC channel</a>, which can be accessed for free without registration from any IRC client.</li>
</ul>
</section>
<section id="code">
<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>
</section>
<section id="affiliated">
<h2>Develop an affiliated package</h2>
<p>Whether you have an idea for a new Astronomy package, or already have a package that you want to integrate with the Astropy project, you can develop an affiliated package! You'll want to join the <a href="http://groups.google.com/group/astropy-dev">astropy-dev</a> list so you can notifying other developers of your intent to develop an affiliated package. Then you can check out the <a href="affiliated/index.html#affiliated-instructions">affiliated package guidelines</a> and the <a href="http://github.com/astropy/package-template">template for new affiliated packages</a> to get started. We can even create a repository for your affiliated package in the astropy organization on GitHub, if you ask on the mailing list!</p>
</section>
<footer>
<script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.1/jquery.min.js"></script>
<script src="js/jquery.sidr.min.js"></script>
<script src="js/functions.js"></script>
</footer>
</div>
<script type="text/javascript">
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-30968842-1']);
_gaq.push(['_setDomainName', 'astropy.org']);
_gaq.push(['_trackPageview']);
(function() {
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
})();
</script>
</body>
</html>