Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
83 lines (55 loc) · 2.15 KB

CONTRIBUTING.md

File metadata and controls

83 lines (55 loc) · 2.15 KB
Raw

Contributing to CodeShield

Thank you for your interest in contributing to CodeShield! We welcome contributions from the community.

Developer Contacts

How to Contribute

Reporting Issues

If you find a bug or have a feature request, please create an issue on our GitHub Issues page.

Pull Requests

We actively welcome your pull requests:

  1. Fork the repository and create your branch from main
  2. If you've added code that should be tested, add tests
  3. If you've changed APIs, update the documentation
  4. Ensure the test suite passes
  5. Make sure your code follows the existing style
  6. Issue your pull request!

Development Setup

  1. Clone the repository:

    git clone https://github.com/Erebuzzz/CodeShield.git
cd CodeShield

  2. Install dependencies:

    pip install -e ".[dev]"

  3. Run tests:

    pytest

Coding Style

  • Follow PEP 8 style guidelines for Python code
  • Use Ruff for linting and formatting
  • Keep line length to 100 characters
  • Write clear, descriptive commit messages

Testing

  • Write tests for new features
  • Ensure all tests pass before submitting a PR
  • Run the test suite with pytest

Documentation

  • Update README.md if you change functionality
  • Add docstrings to new functions and classes
  • Keep documentation clear and concise

Code of Conduct

Our Standards

  • Be respectful and inclusive
  • Accept constructive criticism gracefully
  • Focus on what is best for the community
  • Show empathy towards other community members

Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the project maintainers. All complaints will be reviewed and investigated promptly and fairly.

License

By contributing to CodeShield, you agree that your contributions will be licensed under the MIT License.

Questions?

Feel free to reach out to the maintainers if you have any questions or need help getting started!