You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+10-22Lines changed: 10 additions & 22 deletions
Original file line number
Diff line number
Diff line change
@@ -52,8 +52,8 @@ Code:
52
52
Narrative:
53
53
- Please read through the other tutorials to get a sense of the desired tone and length.
54
54
- 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 anddescrictive
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 andemphasize 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/).
57
57
- Include [Learning Goals](http://tll.mit.edu/help/intended-learning-outcomes) at the top as a bulleted list.
58
58
- Include Keywords as a comma separated list of topics, packages, and functions demonstrated.
59
59
- The first paragraph should give a brief overview of the entire tutorial including relevant astronomy concepts.
@@ -77,12 +77,12 @@ Jane Smith, Jose Jones
77
77
Example, example, example
78
78
79
79
## Companion Content
80
-
Carroll & Ostlie 10.3, Binney &Tremian1.5
80
+
Carroll & Ostlie 10.3, Binney &Tremaine1.5
81
81
82
-
This tutorial goes from a downloading a data file, doing something to it, andvisualizing it.
82
+
In this tutorial, we download a data file, do something to it, andthen visualize it.
83
83
84
-
Procedure
85
-
---------
84
+
Procedurefor Contributing
85
+
--------------------------
86
86
87
87
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.
88
88
@@ -106,27 +106,15 @@ branch:
106
106
All files used by the tutorial -- e.g., example data files, the IPython
107
107
notebook file itself -- should go in this directory.
108
108
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.
122
111
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).
123
112
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'):
126
114
127
115
git push origin Spectral-Line-Fitting
128
116
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`
130
118
repository in order for the community to review the new tutorial.
0 commit comments