Skip to content

Latest commit

 

History

History
70 lines (45 loc) · 2.29 KB

File metadata and controls

70 lines (45 loc) · 2.29 KB

🤝 Contributing to RISE Tutorials

We welcome all contributions — from minor typo fixes to brand-new tutorials. Your involvement helps make this a more valuable and inclusive educational resource for the entire medical imaging community.

🚀 Ways to Contribute

🐞 Report Bugs

Found something odd or broken? Please let us know by opening an issue.

When reporting a bug, include:

  • Your operating system and Python version
  • A brief description of the issue
  • Clear steps to reproduce the problem (screenshots welcome!)

🛠️ Fix Bugs

Check out our open issues. Look for those tagged with:

  • bug
  • help wanted

If something looks doable — go for it! We’re here to help if you get stuck.

✨ Implement Features

Have an idea to improve a tutorial or add a new one? Issues tagged with enhancement and help wanted are a great place to start. Or propose your own feature via a GitHub issue.

📝 Improve Documentation

Whether it’s improving in-line comments, writing a tutorial, or sharing a helpful blog post that references this project — it’s all valuable.

💬 Submit Feedback

File an issue to:

  • Suggest new topics or tools
  • Share what worked (or didn’t) in a tutorial
  • Ask questions or start a discussion

📣 You can also fill out our contribution form to stay in the loop!


🧪 Getting Started with Local Development

Here’s how to set up the project locally to make your contributions:

# 1. Fork the repository on GitHub and clone it
git clone https://github.com/YOUR_USERNAME/rise_tutorials.git
cd rise_tutorials

# 2. Create a virtual environment (recommended)
python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate

# 3. Install dependencies
pip install -r requirements.txt

# 4. Make your changes in a new branch
git checkout -b your-feature-branch

# 5. Commit and push your changes
git add .
git commit -m "Describe your change"
git push origin your-feature-branch

# 6. Open a Pull Request via GitHub!

We’ll review your PR, offer suggestions if needed, and celebrate your contribution once it’s merged! 🎉