Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Contribution Guide(s) need to be consolidated and updated #963

Closed
DFrenkel opened this issue Jul 8, 2020 · 0 comments
Closed

Contribution Guide(s) need to be consolidated and updated #963

DFrenkel opened this issue Jul 8, 2020 · 0 comments
Labels

Comments

@DFrenkel
Copy link
Contributor

@DFrenkel DFrenkel commented Jul 8, 2020

This repo contains a brief Contribution Guide in the .github directory.

However, README references another Contribution Guide instead with similar, expanded, content.

Neither guides contain instructions for setting up this project to be able to do effective testing, such as:


Setup Instructions

Please follow these steps after cloning the repository to make sure you can
modify code and run tests with confidence:

# From the root dir of the cloned repository:
# Create Virtual Environment called env (you may choose your own name)
python3 -m venv env

# Activate virtual environment
source env/bin/activate

# Install this library as edible install
python3 -m pip install -e .

# Install nox
python3 -m pip install nox

From that point, you can just use nox to run linter and unit tests for all supported versions of Python and oauth2client defined in the noxfile.py
Nox will automatically handle constriction of new virtual environments and installation of the required test dependencies.
For more information about Nox, including command-line usage, consult documentation.


I propose the following restructuring:

  • Remove .github/CONTRIBUTING.md
  • Create new CONTRIBUTING.rst at the root of the repo that:
    • Links to the Contribution Guide for basic housekeeping items such as CLA, Code of Conduct, Pull Requests, Style, Code Reviews.
    • Provides setup instructions above
  • Modify README.md to reference new CONTRIBUTING.rst perhaps reinforcing again basic requirements as bullet points
DFrenkel added a commit to DFrenkel/google-api-python-client that referenced this issue Jul 8, 2020
DFrenkel added a commit to DFrenkel/google-api-python-client that referenced this issue Jul 8, 2020
gcf-merge-on-green bot pushed a commit that referenced this issue Jul 9, 2020
* Removing `.github/CONTRIBUTING.md`
* Creating new `CONTRIBUTING.rst` at the root of the repo that:
    * Links to the [Contribution Guide](http://googleapis.github.io/google-api-python-client/contributing.html) for basic housekeeping items such as CLA, Code of Conduct, Pull Requests, Style, Code Reviews.
    * Provides setup instructions and introduces Nox
* Modifying `README.md` to reference new `CONTRIBUTING.rst` 

Fixes: #963
gcf-merge-on-green bot pushed a commit that referenced this issue Jul 15, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

2 participants
You can’t perform that action at this time.