Add instructions and flags for developing on local fork #194
Conversation
e-lo
added
the
📙 docs
|
Documentation available at: |
|
This is where the change was - as rendered at the link above (to facilitate a quicker review): |
CONTRIBUTING.md
Outdated
| @@ -69,6 +73,16 @@ Use the following guidance in creating and responding to pull requests | |||
| - Complete the pull request template as best you can. | |||
| - In order to run all GitHub Actions automations, contributors with adequate permissions (i.e. Registered Contributors) should submit pull requests from a branch on the main repo, rather than from a fork. | |||
|
|
|||
| !!! tip "If you worked from a local fork" | |||
|
|
|||
| If you worked from a local fork instead of a feature branch of the main repository, you will not have the right permissions to run the continuous integration tests when you submit a pull request. To remedy, please push the branch of your local fork to a feature branch of the main repository: | |||
There was a problem hiding this comment.
I'd be a little more specific with language, since "main" is also used for the branch name. For example, If you worked from a fork of the repo instead of a feature branch of the TIDES repo,…
CONTRIBUTING.md
Outdated
| If you worked from a local fork instead of a feature branch of the main repository, you will not have the right permissions to run the continuous integration tests when you submit a pull request. To remedy, please push the branch of your local fork to a feature branch of the main repository: | ||
|
|
||
| ```sh | ||
| git push origin <my-feature-branch-name> |
There was a problem hiding this comment.
I don't think these instructions will work from the fork, which would have origin defined as the forked repo, not TIDES-transit/TIDES. You'd have to add TIDES-transit/TIDES as a remote, and push to that remote, something like,
git remote add upstream git@github.com/TIDES-transit/TIDES.git
git push upstream <my-feature-branch-name>There was a problem hiding this comment.
ah - good point, the remote origin would be your fork. But do you need to add upstream remote or is it automatically added when you fork the repo?
There was a problem hiding this comment.
My understanding is that github tracks the relationship on github, but when you git clone your fork, you're setting up just the remote of your fork (as origin). If you want to push from your local clone of your fork to TIDES-transit/TIDES, you'd have to add the upstream yourself. You've forked the repo, you could test it out!
Fixes #193