Contribution Guidelines

[complexbrains]

A Contribution Guideline to set the standards and help the new contributors to show the way regarding

• where to start
• information regarding the use of the Github/Git/
• Using Issues and project-specific labels
• How to make pull requests/example pull requests/checklist
• How to set the environments at their pc locally/dependencies
• work in a friendly environment and code of conduct
• Recognizing contributions
• Contact points
• Referenced guidelines

Please assign this issue to me dear @shawnrhoads

[shawnrhoads]

Thank you @complexbrains!

I can help with recipe guidelines. For now, this what we decided on:

• recipes will be written in Markdown
• all recipe files will be saved to `content/recipes/*.md'
• recipe files will follow the heuristic: content/recipes/<user-defined-name>_recipe.md
• any images associated with a recipe will follow a heuristic: content/recipes/<user-defined-name>_image_<index>.jpg
• code included in recipe should be roughly 1-10 lines (maybe we want to set a recommended total number of lines in file)
• recipes should include software versions and links to software documentation when possible

https://github.com/neuroimaging-cookbook/neuroimaging-cookbook.github.io/issues/4#issuecomment-743915474

[shawnrhoads]

I quickly updated this template file with these guidelines. I added a recommendation to keep recipes concise and no more than 100 lines.

Please leave a comment if you think we should edit/add anything :)

File: https://raw.githubusercontent.com/neuroimaging-cookbook/neuroimaging-cookbook.github.io/main/content/template_recipe.md Webpage: https://neuroimaging-cookbook.github.io/template_recipe/

[complexbrains]

Here is the PR for the first draft of the contribution guidelines and code of conduct #18

Please let me know about your comments. Thank you 🤗

[shawnrhoads]

AMAZING! Thank you!! I'll take a look at the PR in the next couple of days and let you know if I have any questions/suggestions before merging.