Thanks for your interest in contributing! Please take a moment to review this document in order to make the contribution process easy and effective for everyone involved.
Please ask first before starting work on any significant changes/features!
It is never a fun experience to put a lot of work into a pull request only to have it rejected because it doesn't fit with the project's goals or because someone else is already working on it.
- Fork and clone the repository
- Run
npm installto install dependencies - Run
dotnet build Ignis.slnto build the project
This should be all you need to get started. If you run into any issues, please let us know by opening an issue.
We use Husky.Net to enforce coding standards. As long as you followed the setup instructions above, you should be good to go.
Ignis uses xUnit for unit testing. You can run the tests with the following command:
dotnet test Ignis.slnPlease ensure that the tests are passing when submitting a pull request. If you're adding new features to Headless UI, please include tests!
The above diagram shows the project structure. Ignis contains multiple packages for different purposes. You can read more about them in the documentation.