-
-
Notifications
You must be signed in to change notification settings - Fork 76
Switch to using fork of project repository instead of copying a template #285
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
Merged
Merged
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
0f5eccc
📝 🍱 Switch instructions for replicating the project repository
bielsnohr 795c40f
✏️ Remove missed references to "template" repo
bielsnohr 2963d50
Merge pull request #251 from carpentries-incubator/bielsnohr/249-fork…
anenadic f5a1a0c
Redid screenshots in higher resolution.
anenadic 32f7aab
Update _episodes/11-software-project.md
anenadic File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 |
|---|---|---|
|
|
@@ -54,50 +54,53 @@ to fix and build on top of the existing code during the course. | |
|
|
||
| ## Downloading Our Software Project | ||
|
|
||
| To start working on the project, you will first | ||
| create a copy of the software project template repository | ||
| To start working on the project, you will first create a fork of the software project repository | ||
| from GitHub within your own GitHub account | ||
| and then obtain a local copy of that project (from your GitHub) on your machine. | ||
|
|
||
| 1. Make sure you have a GitHub account | ||
| and that you have set up your SSH key pair for authentication with GitHub, | ||
| as explained in [Setup](../setup.html#secure-access-to-github-using-git-from-command-line). | ||
| 2. Log into your GitHub account. | ||
| 3. Go to the [software project template repository](https://github.com/carpentries-incubator/python-intermediate-inflammation) | ||
| 3. Go to the [software project repository](https://github.com/carpentries-incubator/python-intermediate-inflammation) | ||
| in GitHub. | ||
|
|
||
| {: .image-with-shadow width="800px" } | ||
| {: .image-with-shadow width="900px" } | ||
|
|
||
| 4. Click the `Use this template` button | ||
| towards the top right of the template repository's GitHub page to create | ||
| a **copy** of the repository under your GitHub account | ||
| (you will need to be signed into GitHub to see the `Use this template` button). | ||
| Note that each participant is creating their own copy to work on. | ||
| Also, we are not forking the directory but creating a copy | ||
| (remember - you can have only one *fork* but can have multiple *copies* of a repository in GitHub). | ||
| 4. Click the `Fork` button | ||
| towards the top right of the repository's GitHub page to create | ||
| a **fork** of the repository under your GitHub account | ||
| (you will need to be signed into GitHub for the `Fork` button to work). | ||
| Note that each participant is creating their own fork to work on. | ||
| Also, we are not copying from a template but creating a fork | ||
| (remember you can have only one *fork* | ||
| but can have multiple *copies* of a repository in GitHub). | ||
| 5. Make sure to select your personal account | ||
| and set the name of the project to `python-intermediate-inflammation` | ||
| (you can call it anything you like, | ||
| but it may be easier for future group exercises if everyone uses the same name). | ||
| Also set the new repository's visibility to 'Public' - | ||
| so it can be seen by others and by third-party Continuous Integration (CI) services | ||
| (to be covered later on in the course). | ||
| Ensure that you **uncheck** the `Copy the main branch only` button. | ||
| This will guarantee we get some other branches needed for later exercises, | ||
| but for the minute you can ignore them. | ||
|
|
||
| {: .image-with-shadow width="600px" } | ||
| {: .image-with-shadow width="600px" } | ||
|
|
||
| 6. Click the `Create repository from template` button | ||
| and wait for GitHub to import the copy of the repository under your account. | ||
| 7. Locate the copied repository under your own GitHub account. | ||
| 6. Click the `Create fork` button | ||
| and wait for GitHub to create the forked copy of the repository under your account. | ||
| 7. Locate the forked repository under your own GitHub account. | ||
| You should be taken there automatically after confirming the fork operation, | ||
| but if not, you can click your username top left to be taken to your user page, | ||
| and then select the `Repositories` tab, where you can search for this new fork. | ||
|
|
||
| {: .image-with-shadow width="800px" } | ||
| {: .image-with-shadow width="900px" } | ||
|
|
||
| > ## Exercise: Obtain the Software Project Locally | ||
| > Using the command line, clone the copied repository | ||
| > from your GitHub account into the home directory on your computer using SSH. | ||
| > Which command(s) would you use to get a detailed list of contents of the directory you have just cloned? | ||
| > > ## Solution | ||
| > > 1. Find the SSH URL of the software project repository to clone from your GitHub account. | ||
| > > Make sure you do not clone the original template repository but rather your own copy, | ||
| > > Make sure you do not clone the original repository but rather your own fork, | ||
| > > as you should be able to push commits to it later on. | ||
| > > Also make sure you select the **SSH tab** and not the **HTTPS** one - | ||
| > > you'll be able to clone with HTTPS, but not to send your changes back to GitHub! | ||
|
|
@@ -114,7 +117,7 @@ and then obtain a local copy of that project (from your GitHub) on your machine. | |
| > > $ git clone [email protected]:<YOUR_GITHUB_USERNAME>/python-intermediate-inflammation.git | ||
| > > ~~~ | ||
| > > {: .language-bash} | ||
| > > Make sure you are cloning your copy of the software project and not the template repository. | ||
| > > Make sure you are cloning your fork of the software project and not the original repository. | ||
| > > | ||
| > > 4. Navigate into the cloned repository folder in your command line with: | ||
| > > ~~~ | ||
|
|
||
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file not shown.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.