Contributing

Thanks for contributing!

Guidelines

All changes happen through Pull Requests
Fork the repo and create your branch from main.
Use Conventional Commits for writing explicit and meaningful commit messages.
Use make format to format Lua code to maintain consistent coding styles.
If it's your first time contributing to a project then read About pull requests on GitHub's docs.
Commit only production-ready theme files (themes/).

Theme lua-based generator lives in lib/ and can be built via make commands.

To build the theme, make sure the following are installed:

Install the required Lua dependencies via (from nvim-nightfox-<version>.rockspec):

luarocks make --only-deps --local

Create a fork of the repository and clone it locally.
Use a descriptive name for your topic branch.
Edit the Lua files in lib/.
Run make dev command to generate a Zed theme file in themes/ with theme names suffixed with (dev) for testing.
Run make prod command to generate the production-ready theme file.

One can test the changes in Zed directly by using a symlink of the generated theme file:

Run ln -s $(pwd)/themes/nvim-nightfox.json ~/.config/zed/themes/ (macOS example).
Restart Zed.
The (dev) marked themes should now be available within the editor's theme picker.

By contributing, you agree that your contributions will be licensed under the project's license.