nih-cfde / use-case-library-build

https://use-cases.nih-cfde.org/
1 stars 1 forks source link

Update contributing docs #10

Closed ACharbonneau closed 3 years ago

ACharbonneau commented 3 years ago

I've already imported the contributing docs and issue and pr templates from the original use case library, so they just need to be edited to match.

all pieces of a use case now go into one folder instead of their own folders, and the linking is all automatic. the user needs to fill in the appropriate yaml headers. One thing to note is that as of right now the user has to specify requirements both in the use case AND in the task. Eventually I'll fix this so it's only in task, but for right now users have to do both places and ensure they match manually

https://github.com/nih-cfde/use-case-library-build/blob/latest/templates/CONTRIBUTING.md

marisalim commented 3 years ago

to do list:

marisalim commented 3 years ago

have summarized this in the contrib doc -

the scripts take things from library and impose them on the appropriate templates and then uses stylesheets to make them into a website changing anything except the contents of library unless you are deliberately trying to code in new functionality, will break the everything