Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
98 lines (64 loc) · 2.12 KB

CONTRIBUTING.md

File metadata and controls

98 lines (64 loc) · 2.12 KB

🤝 Contributing to NumPyMasterPro

Thank you for your interest in contributing to NumPyMasterPro! 🚀
Whether you're fixing a bug, adding a notebook, improving documentation, or sharing a use case — your contribution is highly appreciated. 💙

🧭 Project Structure (Quick Overview)


NumPyMasterPro/
├── notebooks/                 # Jupyter Notebooks for learning NumPy
├── scripts/                   # Modular utility scripts
├── datasets/                  # Sample data files
├── docs/                      # Markdown cheat sheets, references
├── requirements.txt           # Python dependencies
└── README.md

✅ How to Contribute

1. Fork the Repo

Click the Fork button at the top right of this page, then clone your fork:

git clone https://github.com/SatvikPraveen/NumPyMasterPro.git
cd NumPyMasterPro

2. Create a Branch

Create a new branch for your contribution:

git checkout -b feature/my-awesome-idea

3. Make Your Changes

  • Follow clean code practices
  • Use meaningful commit messages
  • Add markdown or comments where necessary
  • Format code using black (optional, but appreciated)

4. Test Locally (Recommended)

Use Jupyter or scripts to ensure everything works before submitting.

jupyter lab

5. Commit & Push

git add .
git commit -m "Add: your meaningful commit message"
git push origin feature/my-awesome-idea

6. Submit a Pull Request

  • Go to your fork on GitHub
  • Click "Compare & pull request"
  • Add a clear description of your change

💡 Contribution Ideas

  • Add new notebooks (e.g., PCA, NumPy random tips, simulation)
  • Add explanations to existing notebooks
  • Improve scripts in /scripts
  • Improve docs/ cheat sheets
  • Add datasets for experimentation
  • Report or fix bugs

📜 Code of Conduct

Please read our Code of Conduct before participating.

🙌 Thank You!

Your contributions help grow this project and the community around it. Let’s build NumPy fluency — together!

— The NumPyMasterPro Maintainers