diff --git a/README.md b/README.md index 738036e..61344b1 100644 --- a/README.md +++ b/README.md @@ -8,3 +8,48 @@ > ## Take a look at the [wiki](https://github.com/TySP-Dev/Learn-Python/wiki)! + +## Contributing + +Contributions are welcome! Here's how you can help: + +### 📝 Reporting Issues +- **Errors or typos**: Open an issue describing what needs fixing or submit a PR! +- **Unclear explanations**: Let me know which concept needs better clarification +- **Broken code**: Report any solutions that don't work as expected + +### 💡 Suggesting Content +- **New topics**: Propose Python concepts you'd like covered +- **Practice problems**: Suggest exercises that helped you learn +- **Tools/resources**: Recommend useful Python tools or libraries + +### ✏️ Submitting Changes + +**Pull Requests Welcome!** +PRs are encouraged, but all submissions must be reviewed and approved by myself or featured contributors before merging. + +**Wiki Edits** +- Fix typos, improve wording, or clarify explanations +- Ensure changes maintain consistency with existing style +- Keep explanations beginner-friendly + +**Code Solutions** +- Follow [PEP 8](https://peps.python.org/pep-0008/) style guidelines +- Include comments explaining your approach +- Test thoroughly before submitting +- Add docstrings for functions + +**New Problems** +- Provide a clear problem description +- Include at least one solution with explanation +- Indicate difficulty level (Beginner/Intermediate/Challenges) + +### ⚠️ What Not to Submit +- AI-generated solutions without personal understanding +- Overly complex solutions when simpler ones exist +- Content copied from other sources without attribution + +### Review Process +As a solo maintainer, reviews may take a few days. I'll provide feedback and work with you to refine contributions before merging. All PRs require approval from myself or featured contributors before they can be merged. + +**Questions?** Open an issue and I'll be happy to discuss!