This repo/website is for hosting information about the students in the module, to be maintained by CS3281&2 students collectively. It is maintained as a separate repo because students need write access to it.
While this site uses MarkBind, you can use normal markdown syntax for your updates (MarkBind is compatible with Markdown).
All your files are in a
students/* sub-folder that is named after you e.g.,
students/johnDoe. Update the
info.md file in that folder with your basic info. After you have pushed the updated files to the repo, your info should appear automatically in this page, possibly after a lapse of a few minutes.
If you want to preview the generated site for your changes,
markbind servecommand to generate the site locally, and ensure the output is as you intended.
photo.pngto your folder. Naturally, as the purpose of this photo is for others to identify you, you should choose a recent individual photo showing your face clearly (i.e., not too small) -- somewhat similar to a passport photo.
info.mdfile in your folder.
progress.md in your folder periodically, at least once every two weeks.
|1||Reviewed PR: PR name 1 #1234|
|1||Merged PR: PR name 4 #3245|
|2||Submitted Issue: Issue name #223|
|2||Authored PR (put on hold by request): PR name 3 #365|
|2||Responded to contributor queries: #1234, #4567|
| Week | Achievements | | ---- | ------------ | | 1 | Reviewed PR: [PR name 1 #1234]() | | 1 | Merged PR: [PR name 4 #3245]() | | 2 | Submitted Issue: [Issue name #223]() | | 2 | Authored PR (put on hold by request): [PR name 3 #365]() | | 2 | Responded to contributor queries: [#1234](), [#4567]() |
knowledge.md page in your folder with the knowledge of tools/technologies you gained by doing the project.
observations.md page in your folder with relevant observations from your work under the 'External Project' component.