Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
92 lines (65 loc) · 1.97 KB

CONTRIBUTING.md

File metadata and controls

92 lines (65 loc) · 1.97 KB

Contributing to RAG Governance Framework

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

Code of Conduct

Be respectful, inclusive, and constructive. We're all here to build better AI governance tools.

How to Contribute

Reporting Bugs

  1. Check existing issues to avoid duplicates
  2. Use the bug report template
  3. Include:
    • Node.js version
    • Package version
    • Steps to reproduce
    • Expected vs actual behavior
    • Error messages/logs

Suggesting Features

  1. Check existing issues/discussions
  2. Describe the use case
  3. Explain why it benefits regulated industry users
  4. Consider security/compliance implications

Pull Requests

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/amazing-feature)
  3. Make your changes
  4. Add tests for new functionality
  5. Ensure all tests pass (npm test)
  6. Update documentation if needed
  7. Commit with clear messages
  8. Push and create a Pull Request

Development Setup

# Clone your fork
git clone https://github.com/YOUR_USERNAME/rag-governance-framework.git
cd rag-governance-framework

# Install dependencies
npm install

# Run tests
npm test

# Run examples
npm run example

Code Style

  • Use ES6+ features
  • Add JSDoc comments for public APIs
  • Keep functions focused and small
  • Handle errors gracefully
  • Consider regulated industry requirements

Testing

  • Write tests for all new features
  • Maintain test coverage
  • Test edge cases and error paths
  • Consider security test cases

Documentation

  • Update README for new features
  • Add JSDoc comments
  • Include usage examples
  • Document security considerations

Security

  • Never commit secrets or credentials
  • Consider PII/sensitive data handling
  • Think about audit trail implications
  • Follow secure coding practices

Questions?

Open a discussion on GitHub or reach out to the maintainers.

Thank you for contributing to better AI governance! 🙏