IMPORTANT: before you make any changes, read this entire file. Refer to the markdown formatting guide liberally. Also read our git tutorial for an overview of best practices.
We are in the process of storing lab knowledge here. This includes:
- Coding best practices
- Vesta information (pacakges, maintenance, etc.)
- Database information (schemas, etc.)
- New member how-to's and tutorials
- Other useful procedures and guidelines
Any lab member can edit the markdown (.md) files in this package! We have a purposefully open policy on editing here, so that this works like a wiki rather than a more traditional git repo with a few owners moderating pull requests.
If you copy-paste blocks of unformatted text, we may rollback your commits without warning and ask you to do it again. Please use some simple markdown formatting (click the guide link).
If you have no idea what git is, check out our git tutorial at git.md.
You can edit in a web browser by navigating to the file you want to edit and clicking the little pencil (top right). Be careful! This is not useful for long editing sessions.
The preferred way to edit is to clone this repository to your local machine, then edit and push it back to GitHub.
cd /path/to/my/directory
git clone https://github.com/socdyn/wiki
Open the file you want to edit with your editor, do your thing, and then
git add . file_you_edited.md
git commit -m 'Descriptive commit message here'
git push origin master
Mac users can get [MacDown] (https://github.com/MacDownApp/macdown) for local editing. Use the github2 style rendering for extra compatibility.