contributing.md

Contributing to Deep Learning with PyTorch Tutorials

First off, thank you for considering contributing to our PyTorch tutorials! 🎉 It's people like you that make this resource valuable for the community. We welcome contributions from everyone, whether you're fixing a typo, suggesting improvements, or adding entirely new content.

💡 Ways to Contribute

There are many ways you can help improve these tutorials:

• Found a typo or error? Submit a quick fix!
• Have suggestions for clearer explanations? We'd love to hear them!
• Want to improve code examples? Great! More efficient or clearer examples help everyone.
• Interested in adding new visualizations? Visual explanations can make complex concepts easier to understand.
• Have ideas for new topics? Let us know what you'd like to see added.

Every contribution, no matter how small, helps make these tutorials better!

🚀 Getting Started

1. Set Up Your Environment

If you haven't already, set up your local environment:

# Clone the repository
git clone https://github.com/anand-me/deep-learning-with-pytorch-tutorials.git
cd deep-learning-with-pytorch-tutorials

# Create a virtual environment
python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate

# Install dependencies
pip install -r requirements.txt

2. Create a Branch

Create a branch for your changes:

git checkout -b your-branch-name

Use a descriptive name for your branch that reflects the changes you're making, such as fix-tensor-example or add-transformer-tutorial.

3. Make Your Changes

Now you can make your changes to the notebooks or documentation files. Some tips:

• Keep code examples simple and focused
• Add comments to explain complex operations
• Test all code to ensure it runs without errors
• Follow the existing style for consistency

4. Submit a Pull Request

Once you're happy with your changes:

1. Push your branch to GitHub:

   git add .
   git commit -m "Brief description of your changes"
   git push origin your-branch-name

2. Go to the repository on GitHub and click "Pull Request"

3. Provide a clear description of what your changes do and why they're valuable

📝 Contribution Guidelines

To ensure a smooth collaboration experience, please follow these guidelines:

For Notebooks

• Keep cells organized and logical
• Include markdown explanations before code cells
• Avoid extremely long outputs
• Make sure all dependencies are listed in requirements.txt
• Add appropriate visualizations where helpful

For Documentation

• Use clear, accessible language
• Include examples where appropriate
• Keep explanations concise but complete
• Follow markdown formatting conventions

Code Style

• Follow PEP 8 guidelines for Python code
• Use descriptive variable names
• Include docstrings for functions
• Keep code simple and readable

👥 Community Guidelines

We're committed to providing a welcoming and inclusive environment. When interacting with this project and its community, please:

• Be respectful and kind to others
• Be open to different viewpoints and experiences
• Focus on what is best for the community
• Give and gracefully accept constructive feedback

❓ Questions?

Not sure about something? Have questions about how to implement your contribution? No problem! You can:

• Open an issue with your question
• Reach out to project maintainers
• Comment on existing issues related to your question

We're here to help you make your contribution successful!

🎓 New to Open Source?

If this is your first open source contribution, welcome! Here are some resources to help you get started:

• How to Contribute to Open Source
• GitHub Flow Guide
• First Contributions Tutorial

Remember, every expert was once a beginner. We're happy to help you through your first contribution!

---

Thank you for helping make this project better! 💖