-
Notifications
You must be signed in to change notification settings - Fork 22
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
4959a64
commit 8b6ba5e
Showing
3 changed files
with
21 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -19,10 +19,21 @@ Developer Setup | |
These steps should help you setup a development environment for the Globus CLI. | ||
1. Clone repo: | ||
`git clone [email protected]: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 | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
4 changes: 4 additions & 0 deletions
4
changelog.d/20241107_174803_derek_improve_contributing_doc.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
|
||
### Enhancements | ||
|
||
* Add a "fork" step to the contributing documentation. |