Skip to content

Latest commit

 

History

History
55 lines (33 loc) · 2.26 KB

CONTRIBUTING.md

File metadata and controls

55 lines (33 loc) · 2.26 KB
Raw

Contributing

Introduction

First off, thank you for considering contributing to ts-typekit. Your involvement is what makes ts-typekit a grate tool. Please note that all communications in this repository will be in English.

We are looking for

ts-typekit is an open source project and we love to receive contributions from our community! There are many ways to contribute, from improving the documentation, submitting bug reports and feature requests or writing code which can be incorporated into ts-typekit itselt.

Our Design Princicples

Modern

We embrace modern TypeScript features and best practices to ensure that ts-typekit remains relevant and effective in evolving development environments.

Battle-tested

All utility types in ts-typekit have been rigorosly tested using tsd, ensuing their reliability and robustness in real-world scenarios.

Declartive

Our utilities are designed to be simple, clear, and easy to use, promoting a declarative approach that enhances code readability and maintainability.

Better Documentation

We prioritize comprehensive and accessible documentation, so developers can quickly understand and implement ts-typekit utilities with confidence.

ISSUE

Before starting work on any contribution, please check the existing issues in the repository. If an issue already exists for what you plan to work on, please comment on that issue to indicate your interest in addressing it. If no related issue exists, please create a new one describing the problem or feature you intend to work on.

This helps avoid duplication of effort and ensures that we can discuss and refine the approach before you begin coding.

Pull Request

When you raise your own pull request, the title of your pull request should match the following format. If you forget or are unsure how to do this, please refer to .gitmessage.txt in this repository.

<type>(issue) : <description>

For examples
feat(KeyOf): Add KeyOf type
docs(KeyOf): Add KeyOf documentation

The commit type options is below.

  • FEAT : Add a new feature
  • FIX : Fix a bug
  • DOCS : Update documentation
  • TEST : Add or update tests
  • REFACT : Refactor code
  • STYLE : Changes that do not affect the meaning of the code
  • CHORE : Everything