Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
72 lines (43 loc) · 1.36 KB

CONTRIBUTING.md

File metadata and controls

72 lines (43 loc) · 1.36 KB

Contributing to JobMiner 🎉

First off, thank you for taking the time to contribute to JobMiner!
Your help makes this project better for everyone 🚀

This project is Hacktoberfest-friendly 💻🍂 — feel free to pick issues, open pull requests, or suggest improvements.

🛠 How to Contribute

1. Fork & Clone the Repo

Fork the repository to your GitHub account

git clone https://github.com/beingvirus/JobMiner.git
cd JobMiner

2. Create a Branch

git checkout -b feature/your-feature-name

3. Make Your Changes

Add a new feature

Fix a bug

Improve documentation

Add tests

Optimize existing code

Add scrapers for new job portals

4. Commit & Push

git add .
git commit -m "Added: description of your changes"
git push origin feature/your-feature-name

5. Open a Pull Request

Go to your fork on GitHub

Click New Pull Request

Provide a clear description of your changes

✅ Contribution Guidelines

Follow Python best practices (PEP 8)

Write clear commit messages

Keep PRs small and focused

Update documentation if needed

Test your code before submitting

📜 License

By contributing, you agree that your contributions will be licensed under the MIT License

✨ Thank you for being a part of JobMiner and open source! Happy coding and Happy Hacktoberfest 🎃👩‍💻👨‍💻