Skip to content
Nico Adelhöfer edited this page Feb 10, 2023 · 1 revision

Welcome to the orgshells wiki!

First a few quick notes on how to use this repo.

If anything is unclear, drop a message to [email protected] (maintainer of this repo).

best practices

  • any time, feel free to:
    • comment on issues
    • open new issues
    • assign persons to tasks (because it can always be undone)
    • assign labels to tasks (because it can always be undone)
    • add potentially relevant literature
  • to keep things clean, don't do this by yourself (instead, discuss this first in the issues):
    • add milestones
    • add code; before writing any code (which is not necessary in the foreseeable future anyway), contact the maintainer for best practices
  • keep files in text/code format wherever possible; e.g.:
    • manuscript in latex
    • literature as bibtex file
    • figures created with code

adding literature

  1. edit the file docs/literature/collection.bib
  2. append the bibtex information within this file
  3. good practice - shortly add a comment above the entry, stating the link to this project
Clone this wiki locally