Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.
If you have any substantial changes that you would like to make, please open an issue first to discuss them with us.
Contributions to this project are released to the public under the project's open source license.
Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.
- Fork and clone the repository
- Configure and install the dependencies:
bundle - Make sure the tests pass on your machine:
bundle exec rake - Create a new branch:
git checkout -b my-branch-name - Make your change, add tests, and make sure the tests still pass
- Add an entry to the top of
CHANGELOG.mdfor your changes - Push to your fork and submit a pull request
- Pat yourself on the back and wait for your pull request to be reviewed and merged.
Here are a few things you can do that will increase the likelihood of your pull request being accepted:
- Write tests.
- Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
- Write a good commit message.
If you are the current maintainer of this gem:
- Create a branch for the release:
git checkout -b release-vxx.xx.xx - Bump gem version in
lib/tailwind/view_components/version.rb. Try to adhere to SemVer. - Add version heading/entries to
CHANGELOG.md. - Make a PR to tailwind/view_components.
- Merge tailwind/view_components PR
- Get latest changes from default branch:
git pull origin main - Build a local gem:
gem build tailwind_view_component.gemspec - Tag and push:
git tag vx.xx.xx; git push --tags - Create a GitHub release with the pushed tag and populate it with a list of the changes from
CHANGELOG.md. - Push to rubygems.org --
gem push tailwind_view_component-VERSION.gem