Contributing

Thank you for considering contributing to PigmentTS! We welcome all types of contributions, from bug reports and new features to documentation improvements. Please read the following guidelines before contributing.

How can you Contribute

1. Report Bugs If you encounter any bugs or issues, please report them in the GitHub Issues
2. Suggest New Features We’re always open to new ideas! You can suggest new features or enhancements by creating a GitHub issue.
3. Submit Pull Requests We welcome pull requests (PRs) for new features, bug fixes, and documentation improvements.
4. Improve Documentation Good documentation is essential for any project. If you find any inconsistencies or want to add new examples or tutorials, feel free to contribute.

Run the project locally

Clone the repository

git clone https://github.com/Jay-Karia/pigment-ts

cd pigment-ts

Install dependencies

npm install

Build the project

npm run build

See changes in action

Open node in terminal and import the module

node
> const PigmentTS = require('./dist/index.js');
> PigmentTS.randomColor("hex");

Run tests

npm run test

For more details see CONTRIBUTING.md file