Contributing

Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.

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.

Submitting a pull request

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.md for your changes
If it's your first time contributing, add yourself to the contributors at the bottom of README.md
Push to your fork and submit a pull request
Pat your self 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:

Bump gem version in bridgetown-core/lib/bridgetown-core/version.rb. Try to adhere to SemVer.
Add version heading/entries to CHANGELOG.md.
Make sure your local dependencies are up to date: bundle
Ensure that tests pass and build/release all monorepo gems: bundle exec rake release_all
Push latest master along with new release tag: git push --follow-tags
Create a GitHub release with the pushed tag (https://github.com/bridgetownrb/bridgetown/releases/new) and populate it with a list of the commits from git log --pretty=format:"- %s" --reverse refs/tags/[OLD TAG]...refs/tags/[NEW TAG]