search

datatogether / archivertools

Python package for scraping websites into the Data Together pipeline via morph.io
GNU Affero General Public License v3.0
6 stars 1 forks source link

Added github and python style guides #18

Closed weatherpattern closed 6 years ago

weatherpattern commented 6 years ago

Refers to #11

ebenp commented 6 years ago

Looks ever better! Thanks for the updates.

jeffreyliu commented 6 years ago

Let's flesh out a bit:

Getting Started

How to use Git Version Control How to use GitHub to work collaboratively on software

Style Guide

Coding style follows PEP 8: https://www.python.org/dev/peps/pep-0008/ There are linters that can automatically check your code within your favorite text editor:

Function comments should follow the Google-style docstring conventions: http://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html Some text editors have plugins for automatically generating docstring templates:

jeffreyliu commented 6 years ago

oops, didn't see that it was closed. I'll make another PR with the changes!