> For the complete documentation index, see [llms.txt](https://check-engineering.gitbook.io/ts-utils/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://check-engineering.gitbook.io/ts-utils/contributing.md).

# Contributing

## Table of Contents

* [How to Contribute](#how-to-contribute)
* [Contribution Guidelines](#contribution-guidelines)

## How to Contribute

We welcome and appreciate contributions to the Check-Engineering/TS-Utils package. Your input is valuable to us, and we eagerly anticipate your contributions. If you encounter any issues or have suggestions for enhancements, please feel free to contribute. \
These are a few areas where you can contribute to:

* Core functionalities such as performance improvements, bug fixes, new features, etc.
* Documentation
* Test suite and development of environment improvements.

If you encounter an issue and you do not have the time, or experience to work with the library, don't hesitate to [open a new issue](https://github.com/Check-DC/ts-utils/issues/new).

## Contribution Guidelines

As this package is sensitive in nature, we kindly request that you adhere to the guidelines and maintain the existing code structure when making contributions. This ensures consistency and helps us uphold the quality and integrity of the package. 

To contribute, please follow these steps:

1. Familiarize yourself with the project's purpose and existing code structure.
2. Fork the repository to create a local copy.
3. Create a new branch for your contribution, including a descriptive name and reference to the issue or enhancement.
4. Write clear and concise code that follows the existing coding style.
5. Thoroughly test your changes to ensure they do not break existing functionality.
6. Submit your changes as a pull request to the main repository, including a detailed description of the changes and how they address the issue or enhancement.
7. Respond to feedback by engaging with the project maintainers and other contributors.

**Important: Before pushing your final code, make sure to run the `build` command to generate an updated README file.** 

\
By following these steps and ensuring the README is up to date, you can help ensure that your contributions are well-received and effectively integrated into the project.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://check-engineering.gitbook.io/ts-utils/contributing.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.