From 8b6ba5ebc39e076864867fd091b59867375ca194 Mon Sep 17 00:00:00 2001 From: derek-globus <113056046+derek-globus@users.noreply.github.com> Date: Mon, 9 Dec 2024 10:16:28 -0600 Subject: [PATCH] Updated contributing doc (#1051) --- CONTRIBUTING.adoc | 19 +++++++++++++++---- Makefile | 3 ++- ...7_174803_derek_improve_contributing_doc.md | 4 ++++ 3 files changed, 21 insertions(+), 5 deletions(-) create mode 100644 changelog.d/20241107_174803_derek_improve_contributing_doc.md diff --git a/CONTRIBUTING.adoc b/CONTRIBUTING.adoc index 81b4367d9..b7faae9f1 100644 --- a/CONTRIBUTING.adoc +++ b/CONTRIBUTING.adoc @@ -19,10 +19,21 @@ Developer Setup These steps should help you setup a development environment for the Globus CLI. - 1. Clone repo: - `git clone git@github.com:globus/globus-cli.git && cd globus-cli` - 2. Create a virtualenv for development. `make localdev`. - 3. Activate the resulting virtualenv with `source .venv/bin/activate` + 1. Create a fork of the globus/globus-cli repository. + + Follow https://github.com/globus/globus-cli/fork in a browser. + + 2. Clone your forked repository & navigate to it. + + git clone && cd globus-cli + + 3. Install dependencies in a local virtualenv for development. + + make install + + 4. Activate the resulting virtualenv. + + source .venv/bin/activate You should now have, in your virtualenv, the `globus-cli` installed, pointed at your local copy of the repo. `globus` will invoke code directly out of the diff --git a/Makefile b/Makefile index 0aea3c770..fd7e79275 100644 --- a/Makefile +++ b/Makefile @@ -7,8 +7,9 @@ CLI_VERSION=$(shell grep '^__version__' src/globus_cli/version.py | cut -d '"' - .venv/bin/pip install -e '.[development]' .venv/bin/pip install -e '.[test]' -.PHONY: localdev +.PHONY: localdev install localdev: .venv +install: .venv .PHONY: lint test reference diff --git a/changelog.d/20241107_174803_derek_improve_contributing_doc.md b/changelog.d/20241107_174803_derek_improve_contributing_doc.md new file mode 100644 index 000000000..5842506e7 --- /dev/null +++ b/changelog.d/20241107_174803_derek_improve_contributing_doc.md @@ -0,0 +1,4 @@ + +### Enhancements + +* Add a "fork" step to the contributing documentation.