Skip to content

Latest commit

 

History

History
144 lines (98 loc) · 3.27 KB

CONTRIBUTING.md

File metadata and controls

144 lines (98 loc) · 3.27 KB

Contributing to ts-serializable

Thank you for your interest in contributing! This document provides guidelines for contributing to this project.

Code of Conduct

By participating in this project, you agree to abide by our Code of Conduct.

How to Contribute

Reporting Bugs

Before creating bug reports, please check the existing issues. When creating a bug report, include:

  • Clear title and description
  • Steps to reproduce the problem
  • Expected behavior vs actual behavior
  • Code samples that demonstrate the issue
  • Environment details (Node.js version, npm version, OS)

Suggesting Enhancements

Enhancement suggestions are welcome! Please provide:

  • Clear description of the enhancement
  • Use cases and why it would be useful
  • Possible implementation approach (if you have ideas)

Pull Requests

  1. Fork the repository and create your branch from master
  2. Make your changes following our coding standards
  3. Test your changes by running npm test
  4. Commit your changes using Conventional Commits:
    • feat: for new features
    • fix: for bug fixes
    • docs: for documentation changes
    • chore: for maintenance tasks
    • refactor: for code refactoring
  5. Push to your fork and submit a pull request

Development Setup

Prerequisites

  • Node.js (latest LTS version recommended)
  • npm or pnpm

Setup Steps

# Clone your fork
git clone https://github.com/YOUR_USERNAME/ts-serializable.git
cd ts-serializable

# Install dependencies
npm install

# Run tests
npm test

Coding Standards

This project uses ESLint and TypeScript. Key principles:

Code Style

  • TypeScript: Always use proper types
  • Decorators: Use reflect-metadata for decorator metadata
  • Testing: Write tests for new features
  • Documentation: Add JSDoc comments for public APIs

Example

// Good
class User extends Serializable {
    @jsonProperty(String)
    public name: string = '';
}

// Always include default values
@jsonProperty(Number)
public age: number = 0;

Commit Messages

Follow Conventional Commits:

feat: add support for new ESLint rule
fix: correct TypeScript configuration issue
docs: update README with new examples
chore: upgrade dependencies

Testing

Before submitting your PR:

# Run all tests
npm test

# Run tests with coverage
npm run test:coverage

# Check for security vulnerabilities
npm audit

All tests must pass before your PR can be merged.

Review Process

  1. Automated checks run on every PR (tests, linting, security)
  2. Manual review by maintainers
  3. Feedback may be provided - please address comments
  4. Approval - once approved, your PR will be merged

Release Process

Releases are automated:

  1. Maintainer merges PR to master
  2. Version is bumped automatically
  3. Changelog is generated
  4. Package is published to npm
  5. GitHub release is created

Questions?

  • Open an issue with the question label
  • Check existing issues and discussions

License

By contributing, you agree that your contributions will be licensed under the MIT License.

Thank you for contributing to ts-serializable! 🎉