search

bblockwood / lab

Repository for collecting and documenting work done by research assistants.
0 stars 0 forks source link

Add wiki page for version control #10

Closed bblockwood closed 3 years ago

bblockwood commented 3 years ago

Goal is to add a (brief!) page about using github in accordance with our best practices.

Top should have links to the git book, and to the sourcetree site for downloads.

One part should be: doing simple work from the command line, with a link to here, and with instructions for git fetch, git pull, git commit, and git push.

Another part should describe our basic branch structure, master for the working project, release for whatever version is currently being circulated, and issXX-description branches for issues that are in progress, in order to avoid conflicts.

@afras-sial could you draft this page, and I'll fill in and edit after you've done so? Err on the side of brevity, as I know it could easily become very long.

afras-sial commented 3 years ago

@bblockwood I've added a draft of the GitHub best practices page here. Let me know if I should make any changes. I usually use GitHub desktop rather than the command line, so please see if anything is off in that section since you probably have more familiarity with that content.

bblockwood commented 3 years ago

Fantastic. Looks great. The only change I made was to move the segment about issue tracking onto our dedicated wiki page about issue tracking, which I have further edited and reorganized for completeness.

Summary: the version control wiki page is now posted and up-to-date.