Open issues can be found on the GitHub issues page with a "Bug" label.
These are a great place to start contributing to the repo!
Once you start work on a bug, post your intent on the issue itself. This will prevent more than one person working on it at once.
If the bug you want to work on doesn't have a related issue, open one, and attach the "Bug" label.
Before adding any features, open a Feature Proposal.
This will let us talk through your proposal before you spend time on it.
solid-boundaries is a low-level building block which also makes it flexible. Keep this in mind when proposing a new feature -> does this benefit all of us, or is the feature a more specific use-case?
If a PR introduces or changes API, please make sure to update the relevant docs (readme) or examples (storybook) as well.
In order to get started with your PR:
- Fork the solid-boundaries repo
- Clone york fork locally
- run
pnpm install(make sure you havepnpminstalled on your machine) - See the scripts-section of the
package.jsonof the project for a list of available commands - Add your code and supporting tests
- If this is a feature that requires doc changes, make as necessary.
- You're ready!