https://github.com/digitalnz/code_quality_score
https://github.com/digitalnz/code_quality_score
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/digitalnz/code_quality_score
- Owner: DigitalNZ
- Created: 2024-01-12T02:56:14.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-01-12T02:57:18.000Z (over 2 years ago)
- Last Synced: 2025-03-23T15:38:59.299Z (about 1 year ago)
- Language: Ruby
- Size: 28.3 KB
- Stars: 0
- Watchers: 6
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# CodeQualityScore
TODO: Delete this and the text below, and describe your gem
Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/code_quality_score`. To experiment with that code, run `bin/console` for an interactive prompt.
## Installation
- Add the gem
- Bundle install
- `bundle binstubs code_quality_score`
## Usage
Code is assumed to be in the `app` and `lib` folders of a repository, if they exist.
`bin/code_quality_score` # calculates the score for the current directory
`bin/code_quality_score ../my-repo/` # provide a path to another repository
`bin/code_quality_score_comparison ../base-repo/ ../head-repo/` # compares two versions of a repo and shows the change.
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/code_quality_score.