Skip to content

Latest commit

 

History

History
70 lines (52 loc) · 1.39 KB

CONTRIBUTING.md

File metadata and controls

70 lines (52 loc) · 1.39 KB

Contributing to Commit Sage

We're thrilled that you're interested in contributing to Commit Sage! 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/CommitSage.git
  1. Install dependencies:
npm install
  1. Create a branch for your changes:
git checkout -b feature/your-feature-name

Development

  1. Make your changes
  2. Test your changes:
npm run test
  1. Build the extension:
npm run build

Submitting Changes

  1. Push your changes to your fork
  2. Submit a pull request to the main Commit Sage repository.

Pull Request Guidelines

  • Follow the existing code style
  • Include tests for new features
  • Update documentation as needed
  • Keep changes focused and atomic
  • Describe your changes in detail

Code Style

  • Use TypeScript
  • Follow ESLint rules
  • Write clear commit messages
  • Add JSDoc comments for public APIs

Testing

  • Write unit tests for new features
  • Ensure all tests pass before submitting
  • Test your changes in VS Code

Documentation

  • Update README.md for user-facing changes
  • Add JSDoc comments for new functions
  • Keep documentation clear and concise

Need Help?

Thank you for contributing to Commit Sage!