# Contributing to CVE Checker Library

We welcome contributions to the CVE Checker Library! This document provides guidelines for contributing to the project.

## Getting Started

1. Fork the repository on GitHub.
2. Clone your fork locally: `git clone https://github.com/your-username/cve-checker.git`
3. Create a new branch for your feature or bug fix: `git checkout -b feature-or-bugfix-name`
4. Make your changes and commit them with a clear commit message.
5. Push your changes to your fork: `git push origin feature-or-bugfix-name`
6. Open a pull request on the main repository.

## Development Setup

1. Create a virtual environment: `python -m venv venv`
2. Activate the virtual environment:
   - On Windows: `venv\Scripts\activate`
   - On macOS and Linux: `source venv/bin/activate`
3. Install the development dependencies: `pip install -r requirements.txt`

## Running Tests

We use pytest for testing. To run the tests, execute:

```
pytest tests/
```

## Coding Style

We follow the PEP 8 style guide for Python code. Please ensure your code adheres to this standard.

## Documentation

Please update the documentation when you add or modify features. This includes:

- Updating the README.md file if necessary
- Adding or updating docstrings for functions and classes
- Updating or adding new tests to cover your changes

## Reporting Issues

If you find a bug or have a suggestion for improvement, please open an issue on the GitHub repository. When reporting issues, please include:

- A clear and descriptive title
- A detailed description of the issue or suggestion
- Steps to reproduce the issue (if applicable)
- Any relevant logs or error messages

## Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms. See the `CODE_OF_CONDUCT.md` file for details.

## Contact

If you have any questions about contributing, please contact the project maintainer:

Bassem Abidi (abidi.bassem@me.com)

Thank you for contributing to the CVE Checker Library!
