diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..5b700e2b6 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,64 @@ +# Contributing Guidelines + +Thanks for taking the time to contribute to KomaMRI! ❤️ + +We appreciate your interest in improving this project. Before you start contributing, please take a moment to review the following guidelines. + + +## Reporting Issues + +First off, we assume that you have read the available [Documentation](https://cncastillo.github.io/KomaMRI.jl). + +Before you report an issue, it is best to search for existing [Issues](https://github.com/cncastillo/KomaMRI.jl/issues) that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue. + +If you then still feel the need to report an issue, we recommend the following: + +- Open an [Issue](https://github.com/cncastillo/KomaMRI.jl/issues/new). +- Provide as much context as you can about what you're running into. +- Provide project and platform versions, depending on what seems relevant. + +We will then take care of the issue as soon as possible. + + +## How to Contribute + +1. **Fork KomaMRI Repository**: Fork the [KomaMRI.jl repository](https://github.com/cncastillo/KomaMRI.jl) to your GitHub account to create a personal copy. + +2. **Clone Fork to Local Machine**: Clone your fork of the repository to your local machine using the following Git command: + + ```bash + git clone git@github.com:/KomaMRI.jl.git + ``` + +3. **Create Contribution Branch**: Create a new branch dedicated to your contribution within the cloned repository. + + ```bash + git checkout -b feature/your-feature + ``` + +4. **Implement Code Changes**: Introduce your modifications, ensuring adherence to the [Julia Blue Style Guidelines](https://github.com/invenia/BlueStyle). For new features, include informative comments, docstrings, and consider enriching the documentation with relevant examples. + +5. **Validate Changes with Tests**: Execute existing tests to verify the compatibility of your alterations with the current functionality. If applicable, incorporate additional tests to validate your new contributions. + +6. **Commit Code Changes**: Commit your modifications with a precise and descriptive commit message using the following Git command: + + ```bash + git commit -m "Add a concise summary of your changes" + ``` + +7. **Push Changes to Your Fork**: Push your committed changes to the corresponding branch on your forked repository: + + ```bash + git push origin feature/your-feature + ``` + +8. **Initiate Pull Request (PR)**: Propose your changes by creating a pull request against the `master` branch of the KomaMRI repository. Provide a clear title and a detailed description of your modifications. Ensure that your pull request is linked to an issue by including its #ID in the description. + +9. **Undergo Code Review**: Subject your code to review by maintainers, who will provide feedback and may request further adjustments before merging. + + +## License + +By contributing to KomaMRI, you agree that your contributions will be licensed under the [MIT License](https://github.com/cncastillo/KomaMRI.jl/blob/master/LICENSE). + +Thank you for contributing to KomaMRI! 🌟 diff --git a/README.md b/README.md index bf3e0730d..a1196956f 100644 --- a/README.md +++ b/README.md @@ -47,6 +47,7 @@ Paper:
[![][paper-img1]][paper-url1] |:---------------------|:---------------------------------------------|:---------------------------------------|:---------------------------------| | 📦 KomaMRI.jl | [![][komamri-version]][komamri-juliahub] | [![][gh-actions-img1]][gh-actions-url] | [![][codecov-img1]][codecov-url] | | └ 📦 KomaMRICore.jl | [![][komacore-version]][komacore-juliahub] | [![][gh-actions-img2]][gh-actions-url] | [![][codecov-img2]][codecov-url] | +| └ 📦 KomaMRIIO.jl | [![][komaio-version]][komaio-juliahub] | [![][gh-actions-img4]][gh-actions-url] | [![][codecov-img4]][codecov-url] | | └ 📦 KomaMRIPlots.jl | [![][komaplots-version]][komaplots-juliahub] | [![][gh-actions-img3]][gh-actions-url] | [![][codecov-img3]][codecov-url] | @@ -55,9 +56,11 @@ Paper:
[![][paper-img1]][paper-url1] [komamri-version]: https://juliahub.com/docs/General/KomaMRI/stable/version.svg [komacore-version]: https://juliahub.com/docs/General/KomaMRICore/stable/version.svg [komaplots-version]: https://juliahub.com/docs/General/KomaMRIPlots/stable/version.svg +[komaio-version]: https://juliahub.com/docs/General/KomaMRIIO/stable/version.svg [komamri-juliahub]: https://juliahub.com/ui/Packages/General/KomaMRI [komacore-juliahub]: https://juliahub.com/ui/Packages/General/KomaMRICore [komaplots-juliahub]: https://juliahub.com/ui/Packages/General/KomaMRIPlots +[komaio-juliahub]: https://juliahub.com/ui/Packages/General/KomaMRIIO [docr-img]: https://img.shields.io/badge/docs-stable-blue.svg [docr-url]: https://cncastillo.github.io/KomaMRI.jl/stable/ @@ -69,12 +72,14 @@ Paper:
[![][paper-img1]][paper-url1] [gh-actions-img1]: https://github.com/cncastillo/KomaMRI.jl/workflows/CI/badge.svg [gh-actions-img2]: https://github.com/cncastillo/KomaMRI.jl/workflows/CI/badge.svg [gh-actions-img3]: https://github.com/cncastillo/KomaMRI.jl/workflows/CI/badge.svg +[gh-actions-img4]: https://github.com/cncastillo/KomaMRI.jl/workflows/CI/badge.svg [gh-actions-url]: https://github.com/cncastillo/KomaMRI.jl/actions [codecov-img]: https://codecov.io/gh/cncastillo/KomaMRI.jl/branch/master/graph/badge.svg [codecov-img1]: https://codecov.io/gh/cncastillo/KomaMRI.jl/branch/master/graph/badge.svg?flag=komamri [codecov-img2]: https://codecov.io/gh/cncastillo/KomaMRI.jl/branch/master/graph/badge.svg?flag=core [codecov-img3]: https://codecov.io/gh/cncastillo/KomaMRI.jl/branch/master/graph/badge.svg?flag=plots +[codecov-img4]: https://codecov.io/gh/cncastillo/KomaMRI.jl/branch/master/graph/badge.svg?flag=io [codecov-url]: https://codecov.io/gh/cncastillo/KomaMRI.jl [arXiv-img1]: https://img.shields.io/badge/arXiv-2107.11000-blue.svg @@ -140,6 +145,10 @@ KomaUI() ``` Press the button that says "Simulate!" to do your first simulation :). Then, a notification will emerge telling you that the simulation was successful. In this notification, you can either select to (1) see the Raw Data or (2) to procced with the reconstruction. +## How to Contribute +We welcome contributions from the community! If you're interested in contributing, please read our [Contribution Guidelines](CONTRIBUTING.md) for details on how to get started. + + ## How to Cite If you use this package please acknowledge us by citing our paper.