CONTRIBUTING.md

Contributing

Thank you for investing your time in contributing to this project.

Please note we have a code of conduct, please follow it in all your interactions with the project.

General Steps to Contribute

1. Ensure you have Node and Typescript development environment set up.

2. Fork the project repository.

3. Clone the forked repository by running git clone <forked-repository-git-url>.

4. Navigate to your local repository by running cd Kaoi.

5. Pull the latest changes from upstream into your local repository by running git pull.

6. Create a new branch by running git checkout -b <new-branch-name>.

7. Make changes in your local repository to make the contribution you want. Keep the modular structure of the project in mind while adding code.

8. Commit your changes and push them to your forked repository by running git commit -am "commit-message" && git push origin <new-branch-name>.

9. Create a pull request on the original repository from your fork and wait for it to be reviewed and merged.

Issue Based Contributions

Create a new issue

If you spot a problem or bug with the package, search if an issue already exists. If a related issue doesn't exist, you can open a new issue using a relevant issue form.

Solve an issue

Scan through our existing issues to find one that interests you. You can narrow down the search using labels as filters. See Labels for more information.

Pull Request Process

1. Ensure any install or build dependencies are removed before the end of the layer when doing a build.

2. Update the README.md with details of changes to the interface, this includes new environment variables, new commands, useful info and any relevant links.

3. Increase the version numbers in any examples files and the README.md to the new version that this Pull Request would represent.

Summary

• Contributions are welcome on GitHub. Keep the Code of Conduct in mind while making contributions.

• File any issues or feature requests here, or help resolve existing ones.