Skip to content

Commit 687151c

Browse files
committed
Fix various typos and clarify
1 parent e5fdea4 commit 687151c

File tree

1 file changed

+18
-16
lines changed

1 file changed

+18
-16
lines changed

CONTRIBUTING.rst

Lines changed: 18 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -28,11 +28,12 @@ Overview
2828
* Each tutorial should have 3–5 explicit `Learning Goals
2929
<http://tll.mit.edu/help/intended-learning-outcomes>`_, demonstrate ~2–3
3030
pieces of functionality relevant to astronomy, and 2–3 demonstrations of
31-
generic but commonly used functionality (e.g., numpy, matplotlib)
31+
generic but commonly used functionality (e.g., ``numpy``, ``matplotlib``)
3232
* Roughly follow this progression:
33-
* *Intput/Output*: read in some data (use `astroquery
34-
<https://astroquery.readthedocs.io/en/latest/>`_ where possible
35-
* *Analysis*: do something insightful/useful with the data
33+
* *Input/Output*: read in some data (use `astroquery
34+
<https://astroquery.readthedocs.io/en/latest/>`_ where possible to query
35+
real astronomical datasets)
36+
* *Analysis*: do something insightful / useful with the data
3637
* *Visualization*: make a pretty figure (use `astropy.visualization
3738
<http://docs.astropy.org/en/stable/visualization/>`_ where possible)
3839
* The tutorials must be compatible with the versions supported by the last major
@@ -72,9 +73,9 @@ Narrative
7273
formatting, links, latex, and code snippets.
7374
* Title should be short yet descriptive and emphasize the learning goals of the
7475
tutorial. Try to make the title appeal to a broad audience and avoid
75-
referencing a specefic instrument, catalog, or anything wavelength dependent.
76-
* List all author's full names (comma separated) and link to github profile
77-
and/or `ORCID iD <https://orcid.org/>`_.
76+
referencing a specific instrument, catalog, or anything wavelength dependent.
77+
* List all author's full names (comma separated) and link to GitHub profile
78+
and/or `ORCID iD <https://orcid.org/>`_ when relevant.
7879
* Include `Learning Goals <http://tll.mit.edu/help/intended-learning-outcomes>`_
7980
at the top as a bulleted list.
8081
* Include Keywords as a comma separated list of topics, packages, and functions
@@ -97,22 +98,23 @@ Template intro
9798

9899
.. code-block:: none
99100
100-
# Doing a thing with things
101+
# Title name
101102
102103
## Authors
103104
Jane Smith, Jose Jones
104105
105106
## Learning Goals
106-
- Query..
107-
- Calculate..
108-
- Display..
107+
* Query the ... dataset
108+
* Calculate ...
109+
* Display ...
109110
110111
## Keywords
111112
Example, example, example
112113
113114
## Companion Content
114115
Carroll & Ostlie 10.3, Binney & Tremaine 1.5
115116
117+
## Summary
116118
In this tutorial, we download a data file, do something to it, and then
117119
visualize it.
118120
@@ -126,7 +128,7 @@ concepts `branch, push, pull request <https://help.github.com/articles/proposing
126128

127129
To contribute a new tutorial, first fork the ``astropy-tutorials`` repository.
128130
Then, clone your fork locally to your machine (replace <GITHUB USERNAME> with
129-
your github username)::
131+
your GitHub username)::
130132

131133
git clone [email protected]:<GITHUB USERNAME>/astropy-tutorials.git
132134

@@ -148,8 +150,8 @@ notebook file itself -- should go in this directory.
148150

149151
Specify the python packages the tutorial depends on by creating a text file
150152
called ``requirements.txt`` in the same notebook directory. For example, if your
151-
tutorial requires scipy version 1.0 and numpy version 1.13 or greater, your
152-
``requirements.txt`` file would look like:
153+
tutorial requires ``scipy`` version 1.0 and ``numpy`` version 1.13 or greater,
154+
your ``requirements.txt`` file would look like:
153155

154156
.. code-block:: none
155157
@@ -158,15 +160,15 @@ tutorial requires scipy version 1.0 and numpy version 1.13 or greater, your
158160
159161
To see an example, have a look at the FITS-header `requirements.txt file <https:
160162
//github.com/astropy/astropy-tutorials/blob/master/tutorials/notebooks/FITS-head
161-
er/requirements.json>`_.
163+
er/requirements.txt>`_.
162164

163165
Push the notebook and other files from your local branch up to your fork of the
164166
repository on GitHub (by default, named 'origin')::
165167

166168
git push origin Spectral-Line-Fitting
167169

168170
When the tutorial is ready for broader community feedback, `open a pull request
169-
<https://help.github.com/articles/creating-a-pull-request/>`_against the main
171+
<https://help.github.com/articles/creating-a-pull-request/>`_ against the main
170172
``astropy-tutorials`` repository in order for the community to review the new
171173
tutorial.
172174

0 commit comments

Comments
 (0)