# Contributing When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change. Please note we have a [code of conduct](CODE_OF_CONDUCT.md), please follow it in all your interactions with the project. ## Development environment setup To set up a development environment, please follow these steps: 1. Clone the repo ```shell git clone https://github.com/metaloha/ts-boilerplate ``` 2. Install dependencies ```shell npm ci ``` 3. Run tests ```shell npm run test:watch ``` ## Issues and feature requests You've found a bug in the source code, a mistake in the documentation, or maybe you'd like a new feature? You can help us by submitting an issue to our [GitHub Repository](https://github.com/metaloha/color2color/issues). Before you create an issue, make sure you search the archive, maybe your question was already answered. Please try to create bug reports that are: - _Reproducible._ Include steps to reproduce the problem. - _Specific._ Include as much detail as possible: which version, what environment, etc. - _Unique._ Do not duplicate existing opened issues. - _Scoped to a Single Bug._ One bug per report. Even better: You could submit a pull request with a fix or new feature! ## Pull request process 1. Search our repository for open or closed [pull requests](https://github.com/metaloha/color2color/pulls) that relates to your submission. You don't want to duplicate effort. 2. Fork the project 3. Create your feature branch (`git checkout -b amazing_feature`) 4. Commit your changes (`git commit -m 'add amazing_feature'`) 5. Push to the branch (`git push origin amazing_feature`) 6. Open a pull request