Skip to content

Commit

Permalink
Updated contributing doc (#1051)
Browse files Browse the repository at this point in the history
  • Loading branch information
derek-globus authored Dec 9, 2024
1 parent 4959a64 commit 8b6ba5e
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 5 deletions.
19 changes: 15 additions & 4 deletions CONTRIBUTING.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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 <fork-repo-url> && 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
Expand Down
3 changes: 2 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 4 additions & 0 deletions changelog.d/20241107_174803_derek_improve_contributing_doc.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@

### Enhancements

* Add a "fork" step to the contributing documentation.

0 comments on commit 8b6ba5e

Please sign in to comment.