Skip to content

Commit 35cbf69

Browse files
authored
typos, more on Title, less on metadata
1 parent 1a71323 commit 35cbf69

File tree

1 file changed

+10
-22
lines changed

1 file changed

+10
-22
lines changed

CONTRIBUTING.md

Lines changed: 10 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -52,8 +52,8 @@ Code:
5252
Narrative:
5353
- Please read through the other tutorials to get a sense of the desired tone and length.
5454
- Use [Markdown formatting](http://jupyter-notebook.readthedocs.io/en/latest/examples/Notebook/Working%20With%20Markdown%20Cells.html) in text cells for formatting, links, latex, and code snippets.
55-
- Title should be short and descrictive
56-
- List all author's full names (comma separated) and link to github profile and/or [ORCID](https://github.com/astropy/astropy-tutorials/pull/171) id.
55+
- Title should be short yet descriptive and emphasize the learning goals of the tutorial. Try to make the title appeal to a broad audience and avoid referencing a specefic instrument, catalog, or anything wavelength dependent.
56+
- List all author's full names (comma separated) and link to github profile and/or [ORCID iD](https://orcid.org/).
5757
- Include [Learning Goals](http://tll.mit.edu/help/intended-learning-outcomes) at the top as a bulleted list.
5858
- Include Keywords as a comma separated list of topics, packages, and functions demonstrated.
5959
- The first paragraph should give a brief overview of the entire tutorial including relevant astronomy concepts.
@@ -77,12 +77,12 @@ Jane Smith, Jose Jones
7777
Example, example, example
7878

7979
## Companion Content
80-
Carroll & Ostlie 10.3, Binney & Tremian 1.5
80+
Carroll & Ostlie 10.3, Binney & Tremaine 1.5
8181

82-
This tutorial goes from a downloading a data file, doing something to it, and visualizing it.
82+
In this tutorial, we download a data file, do something to it, and then visualize it.
8383

84-
Procedure
85-
---------
84+
Procedure for Contributing
85+
--------------------------
8686

8787
The process for contributing a tutorial includes the github [fork](https://help.github.com/articles/working-with-forks/), [branch, push, pull request](https://help.github.com/articles/proposing-changes-to-your-work-with-pull-requests/) workflow.
8888

@@ -106,27 +106,15 @@ branch:
106106
All files used by the tutorial -- e.g., example data files, the IPython
107107
notebook file itself -- should go in this directory.
108108

109-
You will also need to edit the notebook file metadata.
110-
(IPython notebook --> edit menu --> edit notebook metadata)
111-
The metadata must contain, at minimum, the following fields:
112-
113-
- link_name (the name of the link which will appear in the list of tutorials)
114-
- author list
115-
- date (month year, e.g. 'July 2013')
116-
117-
Here is an example of one of these files: [FITS-header.ipynb](https://github.com/astropy/astropy-tutorials/blob/master/tutorials/FITS-header/FITS-header.ipynb) (be sure to hit the "raw" button to see the metadata).
118-
119-
Please specify any python packages that the tutorial depends on via the `requirements.json` file.
120-
Almost always this will include a specific version of `astropy`, and perhaps other affiliated packages.
121-
You do this by placing a file called `requirements.json` in the directory that contains the tutorial notebook file.
109+
Specify the python packages the tutorial depends on via the `requirements.json` file.
110+
Place a file called `requirements.json` in the directory that contains the tutorial notebook file.
122111
To see in example of that, have a look at [requirements.json](https://github.com/astropy/astropy-tutorials/blob/master/tutorials/FITS-header/requirements.json).
123112

124-
When you feel like your tutorial is complete, push your local branch up to your
125-
fork of the repository on github (by default, named 'origin'):
113+
Push the notebook and other files on the local branch up to your fork of the repository on github (by default, named 'origin'):
126114

127115
git push origin Spectral-Line-Fitting
128116

129-
[Open a pull request](https://help.github.com/articles/creating-a-pull-request/) against the main `astropy-tutorials`
117+
When the tutorial is ready for broader community feedback, [open a pull request](https://help.github.com/articles/creating-a-pull-request/) against the main `astropy-tutorials`
130118
repository in order for the community to review the new tutorial.
131119

132120
Data Files

0 commit comments

Comments
 (0)