Skip to content

Latest commit

 

History

History
47 lines (33 loc) · 2.59 KB

CONTRIBUTING.md

File metadata and controls

47 lines (33 loc) · 2.59 KB
Raw

Contributing

IMPORTANT: this document has been adapted from the excellent Contributing guide of the UofTCoders' rcourse.

Geographic Data Science'19 is an open-source course, aimed to introduce the use of Python for Geographic Data Science.

How to Contribute

Anyone can contribute to the course repository via [pull requests][pull-requests].

We use GitHub flow to manage changes:

  1. Create a fork of this repository, and clone it to your local computer.
  2. In your local copy of this repository, create a new branch.
  3. Commit your changes to that branch.
  4. Push the edits on that branch to your fork on GitHub.
  5. Submit a pull request to the master repository (darribas/gds19).
  6. If you receive feedback on your pull request, make further commits to the new branch on your fork. These will automatically be added to your pull request.

You may wish to look at How to Contribute to an Open Source Project on GitHub for more detailed instructions. The GitHub Glossary is also a useful resource that explains Git-related terminology.

Format

We follow a consistent format across all course materials.

A lesson is written in markdown and converted automatically into HTML and PDF through a Makefile. See, for example, the .md file of the first lesson and the HTML and PDF versions.

Labs are written as Jupyter Notebooks (.ipynb) and rendered also as HTML and PDF files. See an example of Lab-1, and the HTML and PDF files produced automatically through the Makefile.