Open source
Contributing
How to report a bug, add a template option, or send a pull request.
Bonesmith is MIT licensed and developed in the open. Bug reports, fixes, new template options and documentation improvements are all welcome.
Where to start
Everything happens in the Bonesmith repository on GitHub. Open issues and pull requests there.
Reporting a bug
Open an issue and include:
- The exact command you ran, with flags, and its output.
- Your Bonesmith version (
--version), Node.js version and operating system. - Which package manager you used.
- What you expected to happen instead.
Check Troubleshooting and existing issues first.
Adding or changing an option
Every option is a folder under templates/<axis>/<option>/ with a layer.json, files and Kiro content, so adding one does not touch the core code. See Development for the commands that check your change.
Sending a pull request
- Fork the repository and create a branch from
main. - Keep the change focused: one concern per pull request.
- Run
npm test,npm run lintandnpm run typecheck. - Describe what changed and why.
By contributing, you agree that your work is released under the project's MIT License.