From e215e093a6d14bbfb48d873ffe5fbf361e99e875 Mon Sep 17 00:00:00 2001 From: wasserth Date: Tue, 24 Oct 2023 09:58:49 +0200 Subject: [PATCH] adapt contribution file --- CONTRIBUTING.md | 74 +------------------------------------------------ 1 file changed, 1 insertion(+), 73 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 51c9bb7f4..b94889df8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,75 +1,3 @@ # 🚀 Contributing to TotalSegmentator -Thank you for considering contributing to TotalSegmentator! Your support means the world to us. This document will guide you through the process, step by step. 🙌 - -## 🤝 How to Contribute - -1. **Fork the Repository** 🍴 - - Start by forking this repository. Click the "Fork" button in the top right corner of the repository page. This creates a copy of the repository in your GitHub account. - -2. **Clone the Repository** 📦 - - Clone your forked repository to your local machine using the following command: - - ```shell - git clone https://github.com/your-username/TotalSegmentator.git - ``` - -3. **Create a New Branch** 🌿 - - Create a new branch for your contribution with a descriptive name. For example: - - ```shell - git checkout -b feature/new-feature - ``` - -4. **Make Your Awesome Changes** 🎉 - - Implement your changes and improvements in your branch. - -5. **Commit Your Changes** 💬 - - Commit your changes with a clear and concise message: - - ```shell - git commit -m "Add amazing feature" - ``` - -6. **Push Your Changes** 🚢 - - Push your changes to your forked repository: - - ```shell - git push origin feature/new-feature - ``` - -7. **Create a Pull Request** 🚀 - - Go back to the original TotalSegmentator repository on GitHub. You should see a banner indicating that you've pushed a new branch. Click the "Compare & pull request" button. - -8. **Fill in the Details** 📝 - - Provide a detailed description of your changes in the pull request. Be sure to mention the issue your pull request addresses, if applicable. - -9. **Review and Approval** 👀 - - Your pull request will be reviewed by project maintainers. Be open to addressing any feedback or changes they request. - -10. **Celebrate Your Contribution** 🎈 - - Once your pull request is merged, you've made a valuable contribution to TotalSegmentator! 🎉 - -## 🧐 Issues - -If you're looking for ways to contribute but don't have specific changes in mind, check out the [issue tracker](https://github.com/wasserth/TotalSegmentator/issues) for open issues that need attention. Feel free to pick one and start working on it. - -## 📖 Code of Conduct - -Please note that we have a [Code of Conduct](LICENSE) to ensure a safe and inclusive environment for all contributors. Make sure to follow it in all your interactions within this project. - -## 🌟 Thank You - -Thank you for considering contributing to TotalSegmentator. Your contributions make this project amazing! 💖 - -Happy coding! 🚀 \ No newline at end of file +TotalSegmentator is a open source project and we are happy to accept contributions. There are many ways to contribute, from writing tutorials or blog posts, improving the documentation, submitting bug reports and feature requests or writing code which can be incorporated into TotalSegmentator itself.