Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/samvera/bixby
RuboCop Defaults for Samvera Community projects
https://github.com/samvera/bixby
core-components samvera-community
Last synced: about 2 months ago
JSON representation
RuboCop Defaults for Samvera Community projects
- Host: GitHub
- URL: https://github.com/samvera/bixby
- Owner: samvera
- License: apache-2.0
- Created: 2017-03-30T16:30:59.000Z (almost 8 years ago)
- Default Branch: main
- Last Pushed: 2024-01-23T21:34:11.000Z (12 months ago)
- Last Synced: 2024-04-26T23:21:17.930Z (8 months ago)
- Topics: core-components, samvera-community
- Language: Ruby
- Homepage:
- Size: 98.6 KB
- Stars: 5
- Watchers: 48
- Forks: 2
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Support: SUPPORT.md
Awesome Lists containing this project
README
Bixby: I'd buy that for a dollar!
=================================
Code:
[](https://badge.fury.io/rb/bixby)
[](https://circleci.com/gh/samvera/bixby)
Docs:
[](./CONTRIBUTING.md)
[](./LICENSE)
Community Support: [](http://slack.samvera.org/)
# What is Bixby?
Bixby is a Ruby Gem containing the default configuration settings for [RuboCop](https://github.com/rubocop/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](http://samvera.github.io/core_components.html#requirements-for-a-core-component).
### 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](https://samvera.slack.com/app_redirect?channel=dev)._
# Help
The Samvera Community is here to help. Please see our [support guide](./.github/SUPPORT.md).
See the Samvera Confluence for information at the architecture level:
Additionally, new adopters and potential adopters may find the pages here useful:
Further questions? [Get in touch](https://samvera.atlassian.net/wiki/spaces/samvera/pages/405211682/Getting+Started+in+the+Samvera+Community)
## To Use This
In your `Gemfile`:
```ruby
gem 'bixby'
```
In your `.rubocop.yml`:
```yaml
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](LICENSE.md).
## Releasing
1. `bundle install`
1. Increase the version number in `bixby.gemspec`
1. Increase the same version number in `.github_changelog_generator`
1. 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
1. 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](https://samvera.atlassian.net/wiki/spaces/samvera/pages/405212316/Code+of+Conduct) and [language recommendations](https://github.com/samvera/maintenance/blob/main/templates/CONTRIBUTING.md#language). 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](https://www.instagram.com/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](https://samvera.org/).
