Added GitHub section to onboarding #65
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| # GitHub | ||
|
|
||
| #### Organisation | ||
|
|
||
| NeuroPoly has a github organisation: | ||
| https://github.com/neuropoly | ||
|
Comment on lines
+5
to
+6
There was a problem hiding this comment. Actually there are 7 others too: I've been hesitant to document this here because it's hard to tell what should go where. This information overlaps with what's on https://neuro.polymtl.ca/software.html and should probably take https://intranet.neuro.polymtl.ca/agenda-and-calendar.html into account somehow too. |
||
|
|
||
| #### Purpose | ||
|
|
||
|
|
||
| The purpose of this organization is to host repos that are related to NeuroPoly's projects. Eg: if you publish a paper, you could put the code+data there and link to it in your paper. | ||
|
|
||
| #### Philosophy | ||
|
|
||
| The philosophy of NeuroPoly's lab is to do open science, which means that repos should be public. There are some exception: confidential data/credentials, highly-top-secret scientific research, etc. | ||
|
Comment on lines
+8
to
+15
There was a problem hiding this comment. It's not clear to me what our philosophy of github is. Sometimes we make new orgs, sometimes we don't, sometimes we pay for them and sometimes we don't. Maybe it makes more sense to document the purpose of each org using a org README that will show on the front page of the org, and leave it. At least, we definitely can't host data on GitHub. It's too expensive. We don't even do it for https://github.com/spine-generic/spine-generic/; that stuff is actually hosted on Amazon, which we're paying for; the GitHub repo is just an index into the Amazon servers. |
||
|
|
||
| #### Usage | ||
|
|
||
| If you decide to make your repos private, please make sure to not go above the total size and [BW limits](https://docs.github.com/en/billing/managing-billing-for-git-large-file-storage/about-billing-for-git-large-file-storage#purchasing-additional-storage-and-bandwidth) | ||
|
|
||
| ```{note} | ||
| For students, please always ask your supervisor before creating a repos. | ||
| ``` | ||
|
Comment on lines
+21
to
+23
There was a problem hiding this comment. Maybe this should specify "a private repo"? If the main concern is cost, and cost only applies to private repos, then I don't think we should scare people off from making use of resources. Making a repo shouldn't be a scary thing, it's not a big deal, and in the worst case, we can always just delete it if something really goes bad. |
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.