Skip to content

Latest commit

 

History

History
81 lines (54 loc) · 3.45 KB

CONTRIBUTING.md

File metadata and controls

81 lines (54 loc) · 3.45 KB
Raw

Contributing to Google Drive Python library and cli

Thanks for checking out google-drive-python!

Table of Contents

  1. Types of contributions we're looking for
  2. Ground rules & expectations
  3. How to contribute
  4. Setting up your environment

Types of contributions we're looking for

There are many ways you can directly contribute to google-drive-python:

  • Finding/Fixing bugs.
  • Adding new features.
  • Extending/Improving documentation.
  • Suggesting code style changes.

and feel free if you have other ways of contributing!

Interested in making a contribution? Read on!

Ground rules & expectations

Before we get started, here are a few things we expect from you (and that you should expect from others):

  • Be kind and thoughtful in your conversations around this project. We all come from different backgrounds and projects, which means we likely have different perspectives on "how open source is done." Try to listen to others rather than convince them that your way is correct.
  • Open Source Guides are released with a Contributor Code of Conduct. By participating in this project, you agree to abide by its terms.
  • If you open a pull request, please ensure that your contribution passes all tests. If there are test failures, you will need to address them before we can merge your contribution.
  • When adding content, please consider if it is widely valuable. Please don't add references or links to things you or your employer have created as others will do so if they appreciate it.

How to contribute

If you'd like to contribute, start by searching through the issues and pull requests to see whether someone else has raised a similar idea or question.

If you don't see your idea listed, and you think it fits into the goals of this guide, do one of the following:

  • If your contribution is minor, such as a typo fix, open a pull request.
  • If your contribution is major, such as a new guide, start by opening an issue first. That way, other people can weigh in on the discussion before you do any work.

Setting up your environment

This library/cli is powered by Python.

Running it on your local machine requires the installation of

Once you have that installed, run:

  • ./init-virtual-env.sh
  • source env/bin/activate
  • pip install -e '.[dev]'

And check that the cli is installed

|> google-drive 

Usage: google-drive [OPTIONS] COMMAND

Manage and interact with your Google Drive.

Commands:

...
...

Code & Commit Conventions (CCC)

This library conforms to the black python coding format and expect that contributions follow the git commit style conventions in the Style Guide.

Synopsis:

  • Use black code formatter
  • Make commits atomic
  • Separate subject from body with a blank line
  • Limit the subject line to 50 characters
  • Use the imperative mood in the subject line
  • Wrap the body at 72 characters
  • Use the body to explain what and why vs. how