Contributions to CollaboKeys are welcome. This page explains the process for contributing so your work integrates smoothly with the project.Documentation Index
Fetch the complete documentation index at: https://mintlify.com/tinkerer9/CollaboKeys/llms.txt
Use this file to discover all available pages before exploring further.
Before You Start
When contributing to this repository, please discuss the change you wish to make first — via a GitHub issue, email, or any other channel — with the repository owners before writing code. This avoids duplicated effort and ensures proposed changes align with the project’s direction. All contributors are expected to follow the project’s code of conduct in every interaction with the project and its community.Pull Request Process
Remove build artifacts
Ensure that any install or build dependencies (such as the compiled
src/emulate/helper binary or the dist/ folder) are not included in your pull request before it is finalized.Update the README
If your change affects the public interface — new environment variables, exposed ports, useful file locations, or other interface changes — update
README.md to reflect those changes.Useful Links
- Repository: github.com/tinkerer9/CollaboKeys
- Issues: github.com/tinkerer9/CollaboKeys/issues
- Latest release: github.com/tinkerer9/CollaboKeys/releases/latest
- Maintainer email: makermax101@gmail.com