Skip to content

Commit 93f6452

Browse files
Update cloning instructions (#8)
* Update cloning instructions We now have a clone button. Preserve the manual instructions and workarounds in a collapsed details tab in case there are issues with the clone button. * Making Coursework Planner set up a bit mmore clear * More tweaks --------- Co-authored-by: Barath Vignarajah <[email protected]>
1 parent e94024f commit 93f6452

9 files changed

+41
-14
lines changed

images/create-planner-fork.png

196 KB
Loading

images/fork-planner.png

179 KB
Loading

images/fork-settings-issues.png

171 KB
Loading

images/link-project-board.png

538 KB
Loading

images/project-board-copy-form.png

118 KB
Loading

images/project-board-copy.png

94.5 KB
Loading

images/project-board-public.png

121 KB
Loading

images/project-board-settings.png

67.4 KB
Loading

readme.md

Lines changed: 41 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,59 @@
11
# Welcome to your coursework planner
22

3-
This is how you will plan and manage your coursework at CYF. You will add all your work as issues to your fork of this repository, and then use a [project board](https://github.com/CodeYourFuture/Coursework-Planner/projects?query=is%3Aopen) to manage your work. This is broadly how all technical projects are managed, so you will need lots of practice. Get started today.
3+
This is how you will plan and manage your coursework at CYF. You will add all your work as issues to your fork of this repository, and then use a [project board](https://github.com/CodeYourFuture/My-Coursework-Planner/projects?query=is%3Aopen) to manage your work. This is broadly how all technical projects are managed, so you will need lots of practice. Get started today.
44

55
## 1. How to get set up
66

7-
1. Fork [this repo](https://github.com/CodeYourFuture/Coursework-Planner/) to your own GitHub
8-
2. Turn on `issues` in the `settings`
7+
#### Forking the My-Coursework-Planner repo
98

10-
You must fork to your personal Github account. Forks created in the CYF org will be deleted by a bot.
9+
1. Fork [this repo](https://github.com/CodeYourFuture/My-Coursework-Planner/) to your own GitHub
10+
![image](images/fork-planner.png)
11+
2. You should see your own GitHub username under `Owner`
12+
![image](images/create-planner-fork.png)
13+
3. Turn on `issues` in the `Settings` of your forked version of the repo
14+
![image](images/fork-settings-issues.png)
1115

12-
## 2. Every module, you will add your work as issues
16+
***You must fork to your personal Github account. Forks created in the CYF org will be deleted by a bot.***
17+
18+
#### Creating your project board
19+
20+
1. Go to the [example project board](https://github.com/CodeYourFuture/Coursework-Planner/projects?query=is%3Aopen)
21+
2. Click the three-dot menu, and then select `Make a copy`
22+
![image](images/project-board-copy.png)
23+
3. Make sure your own GitHub username is under `Owner`
24+
![image](images/project-board-copy-form.png)
25+
4. Make your project board public so your mentors can see your progress - open the project board settings
26+
![image](images/project-board-settings.png)
27+
5. Scroll to the bottom to find the setting to make your board public
28+
![image](images/project-board-public.png)
29+
30+
#### Linking the My-Coursework-Planner repo to your project board
31+
1. Go back to your forked version of the My-Coursework-Planner repo
32+
2. Under `Projects`, click `Link a project` and select your project board
33+
![image](images/link-project-board.png)
34+
3. That's it! You're ready to start adding issues to your board!
35+
36+
## 2. In every module, you will add your work as issues
37+
38+
Each sprint in each module has a Backlog page which lists the work you're expected to do for that module. Every item in the list is actually a GitHub issue.
39+
40+
There is a "Clone" button next to each issue. When you're starting a sprint, clone each of its issues into your coursework planner.
41+
42+
Copy issues for each week or at most for each module. The coursework content is updated frequently, you will not have the most up to date tasks on your board if you copy all modules at once.
43+
44+
<details>
45+
<summary>If the Clone button isn't working, expand this for instructions of how to manually clone the issues</summary>
1346

1447
Each module has a module repo. The coursework for each module is added as issues to that repository. All the module repos are listed in the [Table of Contents](https://github.com/CodeYourFuture/Table-of-Contents).
1548

1649
1. Go to the module repo
1750
2. Click on the `Issues` tab
1851
3. Copy each issue from the module repo to your own coursework repo.
1952

20-
We are building a tool to automate this process, but for now you will have to do it manually. We all use the [Kamino Clone Button](https://chrome.google.com/webstore/detail/kamino/ffdebockfdjileaojbbccofhgncmioaf?hl=en) Chrome extension to make this easier, so you could try that.
21-
22-
Copy issues for each week or at most for each module. The coursework content is updated frequently, you will not have the most up to date tasks on your board if you copy all modules at once.
23-
24-
## 3. Refine your tickets and add them to your project board
53+
We have also used the [Kamino Clone Button](https://chrome.google.com/webstore/detail/kamino/ffdebockfdjileaojbbccofhgncmioaf?hl=en) Chrome extension to make this easier, so you could try that.
54+
</details>
2555

26-
1. Copy the [example project board](https://github.com/CodeYourFuture/Coursework-Planner/projects?query=is%3Aopen)
27-
2. Link your new project board to your fork of this repo
28-
3. Add your tickets to the project board, using the labels to help you assign the fields
29-
4. Make your board public in the settings, so your mentors can see it
56+
## 3. Manage and adapt your project board as you learn
3057

3158
There are example project boards attached to each module, showing you ways you can use boards to manage your time, prioritise, scope, and track your work. You should use the _same project board_ all the way through the course, and add to it as you go. Learn as you go, and adapt your board as you learn.
3259

0 commit comments

Comments
 (0)