Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
66 lines (46 loc) · 1.65 KB

CONTRIBUTING.md

File metadata and controls

66 lines (46 loc) · 1.65 KB

Contributing to SkillShield

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

How to Contribute

Reporting Issues

If you find a bug or have a suggestion:

  1. Check if the issue already exists in our issue tracker
  2. If not, create a new issue with:
    • Clear title and description
    • Steps to reproduce (for bugs)
    • Expected vs actual behavior
    • Screenshots if applicable

Submitting Changes

  1. Fork the repository and create your branch from main
  2. Make your changes with clear, focused commits
  3. Test your changes thoroughly
  4. Update documentation if needed
  5. Submit a pull request with a clear description

Pull Request Guidelines

  • Keep changes focused and atomic
  • Follow existing code style
  • Add tests for new features
  • Update README.md if applicable
  • Ensure all tests pass

Code Style

  • Use consistent indentation (2 spaces)
  • Write clear, self-documenting code
  • Add comments for complex logic
  • Keep functions small and focused

Security Contributions

If you discover a security vulnerability:

Development Setup

# Clone the repository
git clone https://github.com/CharlescSturt/skillshield.git
cd skillshield

# Install dependencies
npm install

# Start development server
npm run dev

Questions?

Feel free to open an issue for questions or reach out on Twitter @charlescsturt

Thank you for helping make AI agents safer! 🔒