Skip to content

Latest commit

 

History

History
73 lines (51 loc) · 1.97 KB

CONTRIBUTING.md

File metadata and controls

73 lines (51 loc) · 1.97 KB
Raw

Contributing to Auto_Jobs_Applier_AIHawk

Thank you for your interest in contributing to Auto_Jobs_Applier_AIHawk. This document provides guidelines for contributing to the project.

Bug Reports

When submitting a bug report, please include:

  • A clear, descriptive title prefixed with [BUG]
  • Steps to reproduce the issue
  • Expected behavior
  • Actual behavior
  • Any error messages or screenshots
  • Your environment details (OS, Python version, etc.)

Feature Requests

For feature requests, please:

  • Prefix the title with [FEATURE]
  • Include a feature summary
  • Provide detailed feature description
  • Explain your motivation for the feature
  • List any alternatives you've considered

Pull Request Process

  1. Fork the repository
  2. Create a new branch for your feature/fix
  3. Write clear commit messages
  4. Update documentation as needed
  5. Submit a pull request with a clear description

Code Style Guidelines

  • Follow PEP 8 standards for Python code
  • Include docstrings for new functions and classes
  • Add comments for complex logic
  • Maintain consistent naming conventions

Development Setup

  1. Clone the repository
  2. Install dependencies from requirements.txt
  3. Set up necessary API keys and configurations

Issue Labels

The project uses the following labels:

  • bug: Something isn't working correctly
  • enhancement: New feature requests
  • good first issue: Good for newcomers
  • help wanted: Extra attention needed
  • documentation: Documentation improvements

Testing

Before submitting a PR:

  • Test your changes thoroughly
  • Ensure existing tests pass
  • Add new tests for new functionality
  • Verify functionality with different configurations

Communication

  • Be respectful and constructive in discussions
  • Use clear and concise language
  • Reference relevant issues in commits and PRs
  • Ask for help when needed

The project maintainers reserve the right to reject any contribution that doesn't meet these guidelines or align with the project's goals.