radix-theme-generator/CONTRIBUTING.md

A utility for generating themes for the Radix Themes UI library

# How to contribute

I'm really happy that you're interested in helping out with this little project.

As this is very early days for the project there's not a lot in the way of resources, but please check out the [documentation](./README.md), and also the [list of issues](https://github.com/digitaljohn/radix-theme-generator/issues).

Please submit an issue if you need help with anything.

## Submitting changes

Please send a
[GitHub Pull Request to radix-theme-generator](https://github.com/digitaljohn/radix-theme-generator/pull/new/main) with a clear list of what you've done (read more about [pull requests](https://help.github.com/en/articles/about-pull-requests)). When you send a pull request, please make sure you've covered off all the points in the template.

Make sure you've read about our workflow (below); in essence make sure each Pull Request is atomic but don't worry too much about the commits themselves as we use squash-and-merge.

## Our workflow

We use [GitHub flow](https://guides.github.com/introduction/flow/); it's a lot like git-flow but simpler and more forgiving. We use the `squash and merge` strategy to merge Pull Requests.

In effect this means:

- Don't worry about individual commits. They will be preserved, but not on the main `main` branch history, so feel free to commit early and often, using git as a save mechanism.
- Your Pull Request title and description become very important; they are the history of the main branch and explain all the changes.
- You ought to be able to find any previous version easily using GitHub tabs, or [Releases](https://github.com/digitaljohn/radix-theme-generator/releases)

Thanks, John Chipps-Harding