81 lines (62 loc) · 1.93 KB

Contributing to Shnippet

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

Development Setup

Fork the repository

Clone your fork:

git clone https://github.com/YOUR_USERNAME/shnippet.git
cd shnippet

Install dependencies:
```
npm install
```

Branch Strategy

We use the following branch naming conventions:

main - Production-ready code
feature/* - New features (e.g., feature/add-new-language)
fix/* - Bug fixes (e.g., fix/parser-error)
chore/* - Maintenance tasks (e.g., chore/update-deps)
docs/* - Documentation updates (e.g., docs/update-readme)

Commit Convention

We follow the Conventional Commits specification:

feat: - New features
fix: - Bug fixes
docs: - Documentation changes
style: - Code style changes (formatting, etc.)
refactor: - Code refactoring
test: - Adding or modifying tests
chore: - Maintenance tasks

Example:

feat: add support for Python language
fix: handle empty file edge case
docs: update installation instructions

Pull Request Process

Create a new branch from main using the appropriate prefix
Make your changes
Run tests locally:
```
npm test
```
Push your branch and create a Pull Request
Ensure all status checks pass:
- Tests
- Type checking

Code Style

We use TypeScript for type safety
All tests must pass
All TypeScript errors must be resolved

Release Process

Releases are automated through GitHub Actions. When a PR is merged to main:

The conventional commits workflow will:
- Update the changelog
- Update the version number
- Create a git tag
The publish workflow will:
- Run all tests
- Build the package
- Publish to npm

Questions?

Feel free to open an issue if you have any questions about contributing!