Skip to content

Latest commit

 

History

History
91 lines (56 loc) · 3.94 KB

README.md

File metadata and controls

91 lines (56 loc) · 3.94 KB
Raw

Bixby: I'd buy that for a dollar!

Code: Gem Version Build Status

Docs: Contribution Guidelines Apache 2.0 License

Community Support: Samvera Community Slack

Murphy Sketch

What is Bixby?

Bixby is a Ruby Gem containing the default configuration settings for RuboCop used to enforce common Ruby style guidelines across Samvera community projects.

Product Owner & Maintenance

bixby was a Core Component of the Samvera Community. Given a decline in available labor required for maintenance, this project no longer has a dedicated Product Owner. The documentation for what this means can be found here.

Product Owner

Vacant

Until a Product Owner has been identified, we ask that you please direct all requests for support, bug reports, and general questions to the #dev Channel on the Samvera Slack.

Help

The Samvera Community is here to help. Please see our support guide.

See the Samvera Confluence for information at the architecture level: https://samvera.atlassian.net/wiki/home

Additionally, new adopters and potential adopters may find the pages here useful: https://samvera.org/

Further questions? Get in touch

To Use This

In your Gemfile:

gem 'bixby'

In your .rubocop.yml:

inherit_gem:
  bixby: bixby_default.yml

Versioning & Dependencies

This project depends on rubocop and rubocop-rspec. It supports versions of those gems pessimistically. Beginning with release 1.0.0, we will periodically add support for new versions of the dependencies and manage the included cops. When compatibility breaks, the major version of bixby will be bumped.

Our goal is to insulate downstream projects from breakage due to pre-1.0 version updates in rubocop.

License

Bixby is available under the Apache 2.0 license.

Releasing

  1. bundle install
  2. Increase the version number in bixby.gemspec
  3. Increase the same version number in .github_changelog_generator
  4. Update CHANGELOG.md by running this command:
github_changelog_generator --user samvera --project bixby --token YOUR_GITHUB_TOKEN_HERE
  1. Commit these changes to the main branch
  2. Run rake release

Contributing

If you're working on a PR for this project, create a feature branch off of main.

This repository follows the Samvera Community Code of Conduct and language recommendations. Please do not create a branch called master for this repository or as part of your pull request; the branch will either need to be removed or renamed before it can be considered for inclusion in the code base and history of this repository.

Acknowledgments

The Alex J. Murphy sketch "logo" is courtesy of acid_lich, all rights reserved.

This software has been developed by and is brought to you by the Samvera community. Learn more at the Samvera Community website.

Samvera Logo