Contributing guidelines

[mingxin-zheng]

Signed-off-by: Mingxin Zheng 18563433+mingxin-zheng@users.noreply.github.com

Fixes #1119 .

Description

Provide guidelines for tutorial contributions

Checks

• Notebook runs automatically ./runner [-p <regex_pattern>]

[review-notebook-app]

Check out this pull request on 

See visual diffs & provide feedback on Jupyter Notebooks.

---

Powered by ReviewNB

[Nic-Ma]

Thanks for the quick update, looks good to me.
@wyli @ericspod @rijobro , could you please help also review it?

Thanks in advance.

[ericspod]

Looks good to me!

[wyli]

the command of running one notebook appears multiple times ./runner.sh -p "-and -wholename , perhaps we add a new option ./runner.sh -t in the bash script as a shortcut?

[mingxin-zheng]

the command of running one notebook appears multiple times ./runner.sh -p "-and -wholename , perhaps we add a new option ./runner.sh -t in the bash script as a shortcut?

Agree and only a small question: is -t for --test? @wyli

Added the following in runner.sh

-t|--test)
	pattern+="-and -wholename ./$2"
	echo $pattern
	shift

[wyli]

Thanks @mingxin-zheng The script changes look good

[mingxin-zheng]

@wyli shall we change the Note to Developers in the frontpage README.md to something like "please refer to our contributing guideline"?

https://github.com/Project-MONAI/tutorials/blob/main/README.md#3-note-to-developers

In addition, the string to replace list in the note seems outdated. Maybe I can update that in this PR.

[wyli]

Sure, that'll be helpful. The pull request template could also be updated to remind the developers https://github.com/Project-MONAI/tutorials/blob/main/.github/pull_request_template.md

[mingxin-zheng]

Thanks @wyli . I added the following to the template, if that's what you are thinking of:

- [ ] I have read the [Contributing Guidelines](../CONTRIBUTING.md)

[wyli]

I think a URL to the contrib guide should be enough. But the template checklist should include more detailed items, like whether a license header is included, and maybe things you mentioned in the common recommendation section, file size, dataset license. The goal is to ask the contributors to do some basic self check for every pull request.

[mingxin-zheng]

Thanks @wyli for the clarification, and here it goes:

- [ ] Avoid including large-size files in the PR.
- [ ] Clean up long text outputs from code cells in the notebook.
- [ ] Remove private info such as user name and private key from the notebook and script files.
- [ ] Ensure (1) hyperlinks and markdown anchors are working (2) use relative paths for tutorial repo files (3) put figure and graphs in the `./figure` folder
- [ ] Notebook runs automatically `./runner.sh -t <path to .ipynb file>`