Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
107 lines (77 loc) · 2.13 KB

CONTRIBUTING.md

File metadata and controls

107 lines (77 loc) · 2.13 KB

Contributing to axios-error-handler-ts

Thank you for your interest in contributing! 🎉

Quick Start

# Clone the repository
git clone https://github.com/Jszigeti/axios-error-handler.git
cd axios-error-handler

# Install dependencies
npm install

# Run tests
npm test

# Build the project
npm run build

# Lint and format
npm run lint
npm run format

Project Structure

axios-error-handler/
├── src/              # Source code
├── __tests__/        # Test files
├── dist/             # Build output (generated)
└── .github/          # GitHub workflows and templates

Development Workflow

  1. Fork the repository
  2. Create a branch for your changes: git checkout -b feat/my-feature
  3. Make your changes and commit with conventional commits
  4. Run tests: npm test
  5. Format code: npm run format
  6. Lint code: npm run lint
  7. Push and create a Pull Request

Code Quality Tools

This project uses:

  • TypeScript: Strict type checking
  • ESLint: Code linting with flat config
  • Prettier: Code formatting
  • Jest: Testing framework
  • Husky: Pre-commit hooks
  • lint-staged: Run linters on staged files

Pre-commit hooks automatically:

  • Lint and fix code with ESLint
  • Format code with Prettier

Testing

# Run tests
npm test

# Run tests with coverage
npm test -- --coverage

# Run tests in watch mode
npm test -- --watch

Write tests for:

  • New features
  • Bug fixes
  • Edge cases

Conventional Commits

We follow Conventional Commits:

feat: add new error handler feature
fix: resolve issue with error messages
docs: update README
chore: update dependencies
test: add missing tests
refactor: simplify error handling logic

Release Process

Releases are automated via GitHub Release:

  1. Create a new release on GitHub with a tag (e.g., v1.3.0)
  2. The publish workflow automatically:
    • Runs tests and linting
    • Builds the project
    • Publishes to npm
    • Updates the GitHub Release with artifacts

Questions?

Open an issue or reach out to the maintainers!