From a726a58a78383bfd36355ba150e829b434415e0f Mon Sep 17 00:00:00 2001 From: Yiheng Wang Date: Mon, 9 May 2022 21:02:27 +0800 Subject: [PATCH] update readme Signed-off-by: Yiheng Wang --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 953d27dc..95cbfa06 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ MONAI Model Zoo hosts a collection of medical imaging models in the [MONAI Bundle](https://docs.monai.io/en/latest/bundle_intro.html) format. ## Model Storage -Github limits the size of files allowed in the repository (see [About size limits on GitHub](https://docs.github.com/en/repositories/working-with-files/managing-large-files/about-large-files-on-github)). Therefore, MONAI Model Zoo suggests to use Git Large File Storage (LFS) to store large files for any single file that is larger than 25MB. +Github limits the size of files allowed in the repository (see [About size limits on GitHub](https://docs.github.com/en/repositories/working-with-files/managing-large-files/about-large-files-on-github)). Therefore, MONAI Model Zoo suggests to use Git Large File Storage (LFS) to store large files for any single file that is larger than **25MB**. There are multiple ways to install Git LFS. For example, download [a suitable binary package](https://github.com/git-lfs/git-lfs/releases) and run `./install.sh`. Please refer to the [official guide](https://github.com/git-lfs/git-lfs#getting-started) for more details about how to install and use it. @@ -24,7 +24,7 @@ of the codebase named `[ticket_id]-[task_name]`. Ideally, the new branch should be based on the latest `dev` branch. 1. Make changes to the branch ([use detailed commit messages if possible](https://chris.beams.io/posts/git-commit/)). 1. [Create a new pull request](https://help.github.com/en/desktop/contributing-to-projects/creating-a-pull-request) from the task branch to the dev branch, with detailed descriptions of the purpose of this pull request. -1. For any large files inside the bundle, please use [Git LFS commands](https://github.com/git-lfs/git-lfs/edit/main/README.md#example-usage) to push them properly. +1. For any large files inside the bundle, please use [Git LFS commands](https://github.com/git-lfs/git-lfs/edit/main/README.md#example-usage) to track them properly. 1. Wait for reviews; if there are reviews, make point-to-point responses, make further code changes if needed. 1. If there are conflicts between the pull request branch and the dev branch, pull the changes from the dev and resolve the conflicts locally. 1. Reviewer and contributor may have discussions back and forth until all comments addressed.