forked from astropy/astropy.github.com
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathcontribute.html
executable file
·258 lines (207 loc) · 16.3 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
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
<!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='https://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" />
<link rel="stylesheet" type="text/css" href="css/github_issues.css" />
<title>Astropy | Contribute</title>
<!-- Google analytics -->
<script src="js/analytics.js"></script>
</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.svg" height="32" onerror="this.src='images/astropy_word_32.png; this.onerror=null;"/></a>
<div id="navigation">
<ul>
<li>
<div class="dropdown">
<a>About</a>
<div class="dropdown-content">
<ul>
<li><a href="about.html">About Astropy</a></li>
<li><a href="code_of_conduct.html">Code of Conduct</a></li>
<li><a href="acknowledging.html">Acknowledging & Citing</a></li>
</ul>
</div>
</div>
</li>
<li><a href="help.html">Get Help</a></li>
<li><a href="contribute.html">Contribute</a></li>
<li>
<div class="dropdown">
<a href="http://docs.astropy.org">Documentation</a>
<div class="dropdown-content">
<ul>
<li><a href="http://docs.astropy.org" target="_blank">Current Release</a></li>
<li><a href="http://devdocs.astropy.org/" target="_blank">In Development</a></li>
<li><a href="https://astropy.readthedocs.io/en/lts/index.html" target="_blank">Long-Term Support</a></li>
</ul>
</div>
</div>
</li>
<li><a href="affiliated/index.html">Affiliated Packages</a></li>
<li><a href="team.html">Team</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 id="contribute-to-astropy">Contribute to Astropy<a class="paralink" href="#contribute-to-astropy" title="Permalink to this headline">¶</a></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="about.html#codeofconduct">Astropy Community Code of Conduct</a>.</p>
<a href="#contribute-feedback">Feedback</a> |
<a href="#reporting-issues">Report an issue</a> |
<a href="#contribute-code-or-docs">Code/docs</a> |
<a href="#formal-project-role">Project Role</a> |
<a href="#develop-affiliated-package">Affiliated Package</a> |
<a href="#contribute-financially">Financial</a> |
<a href="#justify-contribution">Academic Contributions</a>
</section>
<section id="feedback">
<h2 id="contribute-feedback">Contribute feedback<a class="paralink" href="#contribute-feedback" title="Permalink to this headline">¶</a></h2>
<p>There are several ways in which you can give feedback. </p>
<ul>
<li>If you would like to give feedback and participate in discussions, we encourage you
to join the <a href="http://mail.python.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>Feature requests from the community are welcome and encouraged. </li>
<li>If you have feedback you would prefer to keep private, you can e-mail <a
href="mailto:[email protected]">[email protected]</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 can be found in the
<a href="https://astropy.slack.com">Astropy Slack team</a> (get an account <a
href="http://joinslack.astropy.org">here</a>). Slack is basically a live web
chat.</li>
<li>If you would like to participate in discussions about how
the Project is run, please join the <a href="http://groups.google.com/group/astropy-dev">
Developer Email List [astropy-dev]</a>.
</li>
</ul>
</section>
<section>
<h2 id="reporting-issues">Reporting Issues<a class="paralink" href="#reporting-issues" title="Permalink to this headline">¶</a></h2>
<p>If you have found a bug in Astropy please report it. The preferred way is to
create a new issue on the Astropy
<a href="http://github.com/astropy/astropy/issues">GitHub issue page</a>;
that requires <a href="https://github.com">creating a free
account</a> on GitHub if you do not have one.</p>
<p>If you prefer not to create a GitHub account, please report the issue to either
the <a href="https://mail.python.org/mailman/listinfo/astropy">astropy mailing list</a>,
the <a href="http://groups.google.com/group/astropy-dev">astropy-dev mailing list</a>
or sending a
private email to the astropy core developers at
<a href="mailto:[email protected]">[email protected]</a></p>
<p>Please include an example that demonstrates the issue that will allow the
developers to reproduce and fix the problem. You may be asked to also provide
information about your operating system and a full Python stack trace; the
Astropy developers will walk you through obtaining a stack trace if it is
necessary.<p>
</section>
<section id="code">
<h2 id="contribute-code-or-docs">Contribute code or documentation<a class="paralink" href="#contribute-code-or-docs" title="Permalink to this headline">¶</a></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>. In particular, we have introduced a labeling system used across most Astropy-related packages which will allow you to find good starting issues. A good label to start with is <a href="https://github.com/search?p=2&q=label%3Apackage-novice&ref=searchresults&state=open&type=Issues&utf8=%E2%9C%93" class="github-label-package">Package-novice</a> which means you don't need much prior experience of the package. You can use the following links to find all the issues labelled this way and also labeled by how much work they involve:</p>
<ul>
<li><a href="https://github.com/search?p=2&q=label%3Apackage-novice+label%3Aeffort-low&ref=searchresults&state=open&type=Issues&utf8=%E2%9C%93" class="github-label-effort">Effort-low</a>: issues that should take a few hours at most
<li><a href="https://github.com/search?p=2&q=label%3Apackage-novice+label%3Aeffort-medium&ref=searchresults&state=open&type=Issues&utf8=%E2%9C%93" class="github-label-effort">Effort-medium</a>: issues that should take a few days at most
<li><a href="https://github.com/search?p=2&q=label%3Apackage-novice+label%3Aeffort-high&ref=searchresults&state=open&type=Issues&utf8=%E2%9C%93" class="github-label-effort">Effort-high</a>: longer term issues
</ul>
<p>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="https://docs.astropy.org/en/latest/development/workflow/get_devel_version.html">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/development_workflow.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 on APEs, check out <a href="https://github.com/astropy/astropy-APEs/blob/master/APE1.rst">APE #1</a> and the <a href="https://github.com/astropy/astropy-APEs/blob/master/README.rst">APE repository's README</a>. There is also a <a href="https://github.com/astropy/astropy/wiki/APE-Overview">wiki page on Astropy's github repository</a> that has an overview of the existing APEs.</p>
</section>
<section id="role">
<h2 id="formal-project-role">Taking on a formal project role<a class="paralink"
href="#formal-project-role" title="Permalink to this headline">¶</a></h2>
<p>
If you are interested in a higher level of contribution to the project, you can consider taking on one of the formal
project roles as listed in the <a href="team.html">Astropy Team</a> page.
</p>
<p>
In order to be nominated for a named Astropy role, it is typical that a person will have
been actively involved in the project for a considerable amount of time (at least a year
and often longer) and have made substantial contributions. They will have shown a
sustained commitment to Astropy by participating actively already in activities related
to the role. This could involve submitting pull requests and participating in
reviews, or discussions in other channels such as mailing lists or Slack, or other
contributions as defined by a particular role. Finally, they need to express a desire to
maintain this involvement going forward and accept the responsibility of having a role.
For example, being a core sub-package maintainer involves interacting with users and
responding to bug reports in a timely manner. If you are interested in taking on such a role, you can volunteer
either on <a href="http://groups.google.com/group/astropy-dev">astropy-dev</a>, by talking to a holder of the
role you are interested in, or a coordination commitee member.
</p>
</section>
<section id="affiliated">
<h2 id="develop-affiliated-package">Develop an affiliated package<a class="paralink" href="#develop-affiliated-package" title="Permalink to this headline">¶</a></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 notify other developers of your intent to develop an affiliated package, and the <a href="https://groups.google.com/forum/#!forum/astropy-affiliated-maintainers">astropy-affiliated-maintainers</a> mailing list to be kept informed of updates to the package template, as well as to have any dicussions related to setting up affiliated packages. 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>
<section id="donate">
<h2 id="contribute-financially">Contribute Financially<a class="paralink" href="#contribute-financially" title="Permalink to this headline">¶</a></h2>
<p>Donations to Astropy are managed by <a href="https://numfocus.org/">NumFOCUS</a>. For donors in the United States, your gift is tax-deductible to the extent provided by law. As with any donation, you should consult with your tax adviser about your particular tax situation. If you would like to donate to astropy, please see the NumFOCUS contribution page for the Astropy Project:</p>
<a class="button" href="https://numfocus.salsalabs.org/donate-to-astropy/index.html" target="_blank">Donate to Astropy</a>
</section>
<section id="justify">
<h2 id="justify-contribution">For academics: How to justify your contribution<a class="paralink" href="#justify-contribution" title="Permalink to this headline">¶</a></h2>
<p> While in some more technical areas, contributing code is recognized as a
goal in and of itself, some academic fields have not yet developed a clear
understanding of the role of code development relative to other more
traditional contributions like publication. This sections aims to
provide suggestions to academics for how you might justify contributions
to the Astropy project if you are in a field or institution that needs
convincing of the value of such contributions.
</p>
<p>Contributing to the Astropy Project as a volunteer directly benefits
the astronomical research community in tangible ways. Nevertheless,
people employed in academic departments may be asked to justify their
time and efforts in terms of direct benefit to their own department or
organization. In this case it is worth highlighting the
well-established role of community service in academia, including:
<ul>
<li>Referring journal papers</li>
<li>Reviewing proposals for funding or for an observatory time allocation committee</li>
<li>Serving on a conference science organizing committee</li>
<li>Serving on an external review committee such as the NASA Senior Review</li>
</ul>
</p>
<p>
These volunteer duties typically bring no direct benefit to the home
department of a researcher, yet they are widely accepted as
necessary to the functioning of global research astronomy. We should
now add the following to the above list of community service duties:
<ul>
<li>Contribute to open source software projects that benefit astronomical research</li>
</ul>
</p>
</section>
<footer>
<script src="https://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>
<hr>
<p>
<img style="vertical-align:middle" src="images/astropy_brandmark.png" height=20><span style="vertical-align:middle">
<a href="code_of_conduct.html"> The Astropy project is committed to fostering an inclusive community</a></span>.
</p>
</footer>
</div>
</body>
</html>