Skip to content

Latest commit

 

History

History
45 lines (30 loc) · 1.55 KB

README.md

File metadata and controls

45 lines (30 loc) · 1.55 KB

Strube Lab Protocol collection

In order to create a new protocol:

Click the "Create new file" button on GitHub, copy-paste the raw content of the template into the new file and then edit and commit directly from the GitHub website.

File name format lp000_title.md

  • lp is lowercase for 'lab protocol'
    • we may introduce other prefixes such as ip (instrument protocol), rp (reagent protocol
  • replace 000 by the next available number; use leading zero
  • append _ and a very short but descriptive title or acronym in lowercase letters
  • append file ending .md (indicating markdown format)

Or create new protocol offline using git

This is the more efficient and professional choice for larger protocols:

  1. create a local copy of the protocols repo on your computer (into a folder strubeprotocols)

    git clone https://github.com/strubelab/protocols.git strubeprotocols

  2. copy the protocol template lp001_labprotocol_template.md

  3. Edit the file, adapting title, description and procedure as indicated in the template

  4. Add and commit the file to the repository. E.g. using git, the following commands work (repeat as you make changes, adapt the file name):

    git add lp000_title.md
git commit -m 'initial commit protocol lp000'

  5. Once finalized, push the new version to the central repository on github:

    git pull
git push