CONTRIBUTING.md

Contributing to LLM Security Scanner

We welcome contributions to the LLM Security Scanner project! To ensure a smooth and effective collaboration, please follow these guidelines.

How to Contribute

1. Fork the repository on GitHub.
2. Clone your forked repository to your local machine.

   git clone https://github.com/YOUR_USERNAME/llm-security-scanner.git
   cd llm-security-scanner

3. Create a new branch for your feature or bug fix.

   git checkout -b feature/your-feature-name
   # or
   git checkout -b bugfix/issue-description

4. Make your changes and ensure they adhere to the project's coding standards.
5. Write tests for your changes. Ensure all existing tests pass.
6. Commit your changes with a clear and descriptive commit message.

   git commit -m "feat: Add new feature for X"
   # or
   git commit -m "fix: Resolve issue with Y"

7. Push your branch to your forked repository.

   git push origin feature/your-feature-name

8. Open a Pull Request to the main branch of the original Prem2868/llm-security-scanner repository. Provide a detailed description of your changes.

Code Style

• Follow PEP 8 for Python code style.
• Use clear and concise variable and function names.
• Add comments where necessary to explain complex logic.

Reporting Bugs

If you find a bug, please open an issue on the GitHub Issues page and provide:

• A clear and concise description of the bug.
• Steps to reproduce the behavior.
• Expected behavior.
• Screenshots or error messages, if applicable.
• Your operating system and Python version.

Feature Requests

For new features or enhancements, please open an issue on the GitHub Issues page and describe:

• The problem you're trying to solve.
• How the new feature would help.
• Any alternative solutions you've considered.

Thank you for contributing to the LLM Security Scanner!