Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
149 lines (97 loc) · 3.41 KB

CONTRIBUTING.md

File metadata and controls

149 lines (97 loc) · 3.41 KB

SmartCV - Resume Screening Tool

SmartCV is an intelligent, open-source application designed to simplify and automate resume screening using machine learning and natural language processing techniques. Whether you're an HR professional or a developer looking to contribute to a meaningful project, SmartCV is the perfect blend of AI and utility.

✨ Features

  • Resume parsing and keyword extraction
  • Intelligent candidate ranking system
  • Skill-based filtering
  • User-friendly UI (optional frontend support)
  • Built using Python, NLP, and ML frameworks

🚀 Getting Started

1. Clone the Repository

git clone https://github.com/AbhinavDhiman34/SmartCV.git
cd SmartCV

2. Create a Virtual Environment

python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate

3. Install Dependencies

pip install -r requirements.txt

4. Run the Project

python app.py

Make sure you have the necessary models downloaded (e.g., nltk, spacy) before running.

🛠️ Development Setup

  1. Use Python 3.8 or above.
  2. Install dependencies in a virtual environment.
  3. Follow PEP8 for code formatting.
  4. Use meaningful commit messages and document your changes.

🌱 Contributing Guidelines

We welcome contributions from everyone. To maintain quality and consistency, please follow the below process:

🔧 Pull Request Process

1. Fork the repository.

git clone https://github.com/<your-username>/SmartCV.git
cd SmartCV

2. Create a feature/bugfix branch.

# For a feature
git checkout -b feature/your-feature-name

# For a bugfix
git checkout -b bugfix/your-bug-description

3. Stage and commit your changes

git add .
git commit -m "Add: Description of the change made"

4. Push your changes

git push origin feature/your-feature-name

5. Open a pull request with a clear description of what you’ve done.

🔀 Branch Naming Conventions

  • feature/<feature-name>
  • bugfix/<bug-description>
  • docs/<doc-name>
  • hotfix/<urgent-fix>

🧹 Code Formatting

  • Follow PEP8 standards.
  • Use tools like black or flake8 to auto-format code.
  • Ensure your code passes all existing tests.

🐞 Raising Issues

We use GitHub Issues to track bugs, features, and discussions.

To raise an issue:

  • Go to the Issues tab.
  • Click on New Issue.
  • Select the appropriate template: Bug Report, Feature Request, or Question.
  • Fill in all the required fields.

Please be respectful and detailed while creating issues.

🏷️ Labels Used

We use the following labels to categorize issues:

  • good first issue – Easy issues to get started with.
  • help wanted – Assistance needed.
  • bug – Reported bugs and errors.
  • enhancement – Feature improvements.
  • documentation – Changes related to docs.

📜 Code of Conduct

Please read and adhere to our Code of Conduct. We are committed to creating a welcoming and respectful environment for everyone.

🙌 Acknowledgements

Thanks to all contributors and users who help improve this project.

📬 Contact

Have questions? Feel free to open an issue or contact the maintainer via GitHub.