Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
67 lines (45 loc) · 1.59 KB

CONTRIBUTING.md

File metadata and controls

67 lines (45 loc) · 1.59 KB

Contributing to Rootly CLI

Thank you for your interest in contributing to Rootly CLI! This document provides guidelines and instructions for contributing.

Getting Started

  1. Fork the repository
  2. Clone your fork: git clone https://github.com/YOUR-USERNAME/rootly-cli.git
  3. Create a new branch: git checkout -b feature/your-feature-name
  4. Install dependencies: npm install

Development Workflow

Building

npm run build

Running in Development

npm run dev

Linting

npm run lint

Code Style

  • Use TypeScript for all new code
  • Follow the existing code structure and patterns
  • Use meaningful variable and function names
  • Add comments for complex logic
  • Keep functions focused and small

Command Structure

Commands follow this pattern:

  • rootly <resource> <action> [options]
  • All commands support --format flag (json or table)
  • Use commander.js for CLI structure
  • Use @wyre-technology/node-rootly for API calls

Pull Request Process

  1. Update the README.md with details of changes if applicable
  2. Update the CHANGELOG.md following Keep a Changelog format
  3. Ensure your code builds without errors
  4. Create a pull request with a clear description of changes

Commit Messages

  • Use clear, descriptive commit messages
  • Start with a verb in present tense (e.g., "Add", "Fix", "Update")
  • Reference issue numbers when applicable

Questions?

Open an issue for any questions or concerns.

License

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