hellenic-holidays/CONTRIBUTING.md

A modern TypeScript package for Greek holidays and Orthodox celebrations

# Contributing to Hellenic Holidays

Thank you for your interest in contributing to Hellenic Holidays! We welcome contributions from the community to help make this package even better.

## Code of Conduct

By participating in this project, you agree to abide by our Code of Conduct. Please be respectful and constructive in your interactions with other contributors.

## How to Contribute

1. Fork the repository
2. Create a new branch for your feature/fix: `git checkout -b feature/your-feature-name`
3. Make your changes
4. Write or update tests as needed
5. Ensure all tests pass: `npm test`
6. Commit your changes: `git commit -m "Add some feature"`
7. Push to your fork: `git push origin feature/your-feature-name`
8. Open a Pull Request

## Development Setup

1. Clone your fork of the repository
2. Install dependencies:

```bash
npm install
```

3. Run tests:

```bash
npm test
```

## Pull Request Guidelines

- Ensure your code follows the existing style
- Include tests for any new functionality
- Update documentation as needed
- Keep your PR focused on a single feature/fix
- Maintain the existing code coverage (100%)

## Running Tests

```bash
# Run all tests
npm test

# Run tests in watch mode
npm run test:watch

# Run tests with coverage
npm run test:coverage
```

## Reporting Issues

When reporting issues, please include:

- A clear description of the issue
- Steps to reproduce
- Expected behavior
- Actual behavior
- Version of the package you're using
- Node.js version

## Feature Requests

We welcome feature requests! Please provide:

- A clear description of the feature
- Use cases for the feature
- Any relevant examples

## License

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