Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
72 lines (49 loc) · 1.32 KB

CONTRIBUTING.md

File metadata and controls

72 lines (49 loc) · 1.32 KB

Contributing to markdown-tree-parser

Thank you for your interest in contributing to markdown-tree-parser!

Development Setup

  1. Fork the repository on GitHub

  2. Clone your fork locally:

    git clone https://github.com/YOUR_USERNAME/markdown-tree-parser.git
cd markdown-tree-parser

  3. Install dependencies:

    npm install

  4. Create a new branch for your feature:

    git checkout -b feature/your-feature-name

Before Submitting

Make sure your changes pass all checks:

# Run tests
npm test

# Run linting
npm run lint

# Format code
npm run format

# Test CLI
npm run test:cli

Commit Guidelines

  • Use clear, descriptive commit messages
  • Follow conventional commit format when possible:
    • feat: for new features
    • fix: for bug fixes
    • docs: for documentation changes
    • test: for test improvements
    • refactor: for code refactoring

Pull Request Process

  1. Ensure all tests pass and code is properly formatted
  2. Update documentation if needed
  3. Add tests for new functionality
  4. Submit a pull request with a clear description of changes

Code Style

This project uses:

  • ESLint for code linting
  • Prettier for code formatting
  • Conventional commit messages

Questions?

Feel free to open an issue for any questions or discussions!