Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
65 lines (45 loc) · 1.68 KB

CONTRIBUTING.md

File metadata and controls

65 lines (45 loc) · 1.68 KB

Contributing to Sentinel Package Manager

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

Getting Started

  1. Fork the repository
  2. Clone your fork: git clone https://github.com/YOUR-USERNAME/sentinel.git
  3. Create a branch: git checkout -b feature/your-feature-name
  4. Make your changes
  5. Test your changes
  6. Submit a pull request

Development Setup

# Clone the repository
git clone https://github.com/ds-horizon/sentinel.git
cd sentinel

# No dependencies needed - uses only Node.js built-ins
# Just ensure you have Node.js >= 18.0.0

Testing

# Run comprehensive test suite (recommended)
npm test                      # Host + local source

# Docker testing (safe isolation)
npm run test:docker           # Docker + local source
npm run test:docker:npm       # Docker + npm package

# Quick smoke tests
npm run test:smoke

# Or directly from sample-test-repo/
./tests/test.sh               # Host + local source
./tests/test.sh --docker      # Docker + local source
./tests/test.sh --docker --npm # Docker + npm package

Code Style

  • Use ES modules (import/export)
  • Follow existing code style
  • Add comments for complex logic
  • Keep functions focused and small

Pull Request Process

  1. Update documentation if needed
  2. Ensure all tests pass
  3. Update CHANGELOG.md if applicable
  4. Submit PR with clear description

Security

If you discover a security vulnerability, please report it by creating a private security advisory on GitHub instead of opening a public issue.

Questions?

Open an issue for questions or discussions.