Skip to content

Latest commit

 

History

History
51 lines (35 loc) · 3.48 KB

CONTRIBUTING.md

File metadata and controls

51 lines (35 loc) · 3.48 KB
Raw

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

  1. Fork and clone the repository
  2. Configure and install the dependencies: bundle
  3. Make sure the tests pass on your machine: bundle exec rake
  4. Create a new branch: git checkout -b my-branch-name
  5. Make your change, add tests, and make sure the tests still pass
  6. Add an entry to the top of CHANGELOG.md for your changes
  7. If it's your first time contributing, add yourself to the contributors at the bottom of README.md
  8. Push to your fork and submit a pull request
  9. 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.

AI-generated Code Policy

We respectfully ask that you refrain from using AI-generated code when contributing to this project. This includes code generated by tools such as GitHub Copilot, even if you make alterations to it afterwards. While some of Copilot's features may be convenient, the ethics surrounding which codebases the AI has been trained on and their corresponding software licenses remain very questionable and have yet to be tested in a legal context.

We would like to avoid all ethical and legal challenges that result from using AI-generated code. As such, we respectfully ask that you refrain from using such tools when contributing to this project. At this time, the maintainers will not knowingly accept any code which has been generated in such a manner.

Releasing

If you are the current maintainer of this gem:

  1. Bump gem version in bridgetown-core/lib/bridgetown-core/version.rb. Try to adhere to SemVer.
  2. Add version heading/entries to CHANGELOG.md.
  3. Make sure your local dependencies are up to date: bundle
  4. Ensure that tests pass and build/release all monorepo gems: bundle exec rake release_all
  5. Push latest main along with new release tag: git push --follow-tags
  6. 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]

Attribution

Special thanks to the ViewComponent project for providing the language comprising the bulk of this document, and to the Shoelace project for inspiring language regarding the avoidance of AI-generated code.