Merge pull request #99 from laurenmarietta/add-git-ignore

Ignore convert.py products

CONTRIBUTING.md

@@ -8,6 +8,10 @@ Contributions are welcome from both inside and outside the institute.
 4. Create your notebook. It can be anywhere within the `notebooks` directory or any level of sub-directory, but each notebook should be in its *own* directory with no other notebooks or other files.
 5. Develop your notebook by adding and committing it (`git add path/to/my/notebook/notebook.ipynb`,  `git commit -m 'Added some feature'`), as many times as necessary to capture your development history.  Note that you should *never* commit a notebook with executed cells or commit large data files (see the guide).  Always "Clear Ouputs" on cells before adding/committing.
 6.  Add a ``requirements.txt`` file next to your notebook.  Each line should be a separate package following `pip` [requirements file conventions](https://pip.pypa.io/en/stable/reference/pip_install/#requirement-specifiers), listing all the required packages for your notebook, including a "known good version" (e.g., if you wrote the notebook on numpy v1.14.0, the line should be ``numpy>=1.14.0``).
+    - **A note on supplemental files:** 
+        - Including supplemental files with your notebook is discouraged, and should only occur if the files are not accessible online (e.g. via MAST).
+        - See the [style guide](https://github.com/spacetelescope/style-guides/blob/master/guides/where-to-put-your-data.md) for more detailed guidance on how to handle supplemental data.
+        - If you do need to add additional files, however, be sure to add that file name to the "Exceptions committed to repo" list within ``notebooks/notebooks/.gitignore``. For example, if you need to add ``diagram.jpg`` to your notebook ``DrizzlePac/sky_matching``, then add ``!DrizzlePac/sky_matching/diagram.jpg`` to the ``.gitignore`` list (don't forget the ``!``). Otherwise, git won't recognize your file. 
 7. Push to your github fork's branch (`git push origin my-new-feature`)
 8. Create a new Pull Request from your fork into `spacetelescope` using the GitHub web site.  Be sure to include a description that's sufficient for someone *not in your team* to understand the context of the notebook (not all reviewers will be from your team.)
 

notebooks/.gitignore

@@ -0,0 +1,38 @@
+# Files generated by convert.py
+# -----------------------------
+exec_*.ipynb
+*.html
+*.fits
+*.coo
+*.match
+*.log
+*.png
+*.list
+*.txt
+*.cat
+*.jpg
+*.gif
+*.zip
+DrizzlePac/Initialization/reference_files/
+DrizzlePac/drizzle_wfpc2/reference_files/
+MAST/Kepler/Kepler_Lightcurve/mastDownload/
+MAST/Kepler/Kepler_TPF/mastDownload/
+
+# Exceptions committed to repo
+# ----------------------------
+!DrizzlePac/align_sparse_fields/input_flc.list
+!DrizzlePac/mask_satellite/sat.jpeg
+!DrizzlePac/sky_matching/drz.list
+!DrizzlePac/sky_matching/labeled_local_globalmatch_match.gif
+!DrizzlePac/sky_matching/MDRIZSKY_Values.png
+!MAST/HSC/HSC_TAP/smc_colormag.png
+!MAST/Kepler/Kepler_FFI/ffi_tic_plot.png
+!MAST/Kepler/Kepler_TPF/tpf_fluxplot0.png
+!MAST/Kepler/Kepler_TPF/tpf_fluxplot_28-29.png
+!MAST/Kepler/Kepler_Lightcurve/light_curve_tres2.png
+!MAST/K2/K2_FFI/kepler_focal_plane_layout_channels_color.png
+!MAST/PanSTARRS/PS1_DR2_TAP/stsci_pri_combo_mark_horizonal_white_bkgd.png
+!**/requirements.txt
+!**/skyfile.txt
+!**/exclusions.txt
+!**/inclusions*.txt