cnerg/snippets

Repo structure mainenance

Opened this issue · 1 comments

kkiesling commented

discussion of how to structure this repo and what needs to be done to setup the repo properly:

  • maintain all scripts in the master branch
  • one master README with other READMEs for all the snippets
  • full on testing directory
  • CI
bam241 commented

here is the structure I was thinking about setting up:
Issue a PR on Snippet repo to set the structure:

  • REAME.md (quick description of the different snippets with link to full description)
  • Source folder:
    - Source files: Code file + Description file (md file with deps/refs/usage)
  • Tests
  • CI