Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
101 lines (72 loc) · 2.29 KB

CONTRIBUTING.md

File metadata and controls

101 lines (72 loc) · 2.29 KB

Contributing to Cursor Ops Kit

Thank you for your interest in contributing to Cursor Ops Kit! This document provides guidelines and instructions for contributing to this project.

Code of Conduct

Please read and follow our Code of Conduct before contributing.

Getting Started

  1. Fork the repository
  2. Clone your fork: git clone https://github.com/your-username/cursor-ops-kit.git
  3. Create a new branch: git checkout -b feature/your-feature-name
  4. Install dependencies: npm install
  5. Make your changes
  6. Run tests: npm test
  7. Submit a pull request

Development Workflow

Prerequisites

  • Node.js (v14 or higher)
  • npm (v6 or higher)

Setup

  1. Install dependencies:

    npm install

  2. Run tests:

    npm test

  3. Run linting:

    npm run lint

Making Changes

  1. Create a new branch for your feature or bugfix
  2. Make your changes
  3. Add tests for your changes
  4. Update documentation if necessary
  5. Run tests and linting
  6. Commit your changes with a descriptive message
  7. Push your branch to your fork
  8. Create a pull request

Pull Request Process

  1. Update the README.md with details of changes if applicable
  2. Update the CHANGELOG.md with details of changes
  3. Ensure all tests pass
  4. Ensure linting passes
  5. The PR will be merged once you have the sign-off of at least one maintainer

Code Style

  • Follow the existing code style
  • Use 2 spaces for indentation
  • Use camelCase for variable and function names
  • Add comments for complex logic
  • Write tests for new features

Testing

  • Write unit tests for new features
  • Ensure all tests pass before submitting a PR
  • Update tests if you're fixing a bug

Documentation

  • Update documentation for any changes to the API
  • Add examples for new features
  • Keep the README.md up to date

Issue Reporting

  • Check if the issue has already been reported
  • Use the issue template
  • Provide as much detail as possible
  • Include steps to reproduce
  • Include expected and actual behavior

Feature Requests

  • Use the feature request template
  • Explain the feature in detail
  • Explain why it would be useful
  • Provide examples if possible

Questions

For questions about the project, please open an issue with the "question" label.

Thank you for contributing!