generated from fastai/nbdev-template
-
Notifications
You must be signed in to change notification settings - Fork 16
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
skaliy
committed
Jul 12, 2023
1 parent
d416e88
commit 5f44c90
Showing
1 changed file
with
8 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,9 +1,11 @@ | ||
# How to contribute | ||
For any issues related to the source code, please open an issue in the corresponding GitHub repository. Contributions to the code or the model are welcome and should be proposed through a pull request. | ||
Contributions to the source code are greatly appreciated. If you find any issues or have suggestions for improvements, please open an issue in the corresponding GitHub repository. To contribute code changes, we encourage you to follow these [steps](https://docs.github.com/en/get-started/quickstart/contributing-to-projects). | ||
|
||
## How to get started | ||
Install the git hooks that run automatic scripts during each commit and merge to strip the notebooks of superfluous metadata (and avoid merge conflicts). After cloning the repository, run the following command inside it: | ||
nbdev_install_hooks | ||
## Getting Started | ||
1. Install an editable version of the forked project: `pip install -e 'fastMONAI[dev]'` | ||
2. Git hooks are used to run automatic scripts during each commit and merge to strip the notebooks of superfluous metadata and avoid merge conflicts. To set up Git hooks, run the following command inside the project folder: `nbdev_install_hooks` | ||
3. Once you have installed the project and set up the Git hooks, you can start making changes to the notebooks. | ||
4. Run: `nbdev_prepare` to build .py modules from notebooks and test them (if unit tests are written). | ||
|
||
1. pip install -e 'fastMONAI[dev]' | ||
2. nbdev_install_hooks | ||
## Contact | ||
If you have any questions or need further assistance, please contact us at [skaliyugarasan@hotmail.com]. We appreciate your interest and look forward to your contributions. |