CONTRIBUTING.md

Contributing to Resume Parser Project

Thank you for your interest in contributing! We welcome all contributions, whether it’s fixing bugs, adding features, improving documentation, or refactoring code. Please follow the guidelines below to ensure a smooth collaboration.

Table of Contents

1. Setting Up the Environment
2. Project Structure
3. Code Style Guidelines

---

Setting Up the Environment

To start contributing, follow these steps:

Prerequisites

• Ensure you have Python 3.x installed.
• Install the necessary libraries using the following command:

pip install -r requirements.txt

Project Structure

• program.py: The primary script containing the resume classification logic.
• data/: Folder containing the dataset files (e.g., UpdatedResumeDataSet.csv).

Code Style Guidelines

• Follow PEP 8 coding standards for writing Python code.
• Use meaningful variable and function names that make the code self-explanatory.
• Write docstrings for functions and classes.
• Avoid redundant code; follow the DRY (Don’t Repeat Yourself) principle.
• For text processing, ensure consistency in cleaning and tokenizing text using provided methods such as cleaning() and preprocess().