Syndication Icon
Published February 5, 2017 Updated June 4, 2021
Code Quality Icon

Code Quality

Git Badge
Circle CI Status

These are global configurations for ensuring high quality and consistent software development practices. Feel free to link to this project in order to apply these configurations to your projects. You may also fork this project to customize further for your specific needs.

This project only supports tools which can import configurations via a URL.

Features

  • Provides global configurations for tools that support URL imports.

  • Provides global configurations for the following tools:

Requirements

Setup

No setup is required other than what is mentioned in the Requirements section.

Usage

This project is designed to be linked to your own projects. This can be done via one of the following options:

Current Version (stable)

https://raw.githubusercontent.com/bkuhlmann/code_quality/7.0.0/configurations/<choose file>

Master Version (unstable)

https://raw.githubusercontent.com/bkuhlmann/code_quality/main/configurations/<choose file>

Here is a more concrete example using Rubocop. In your local .rubocop.yml, replace the contents with the following:

inherit_from:
  - https://raw.githubusercontent.com/bkuhlmann/code_quality/7.0.0/configurations/rubocop/ruby.yml
  - https://raw.githubusercontent.com/bkuhlmann/code_quality/7.0.0/configurations/rubocop/performance.yml
  - https://raw.githubusercontent.com/bkuhlmann/code_quality/7.0.0/configurations/rubocop/rails.yml
  - https://raw.githubusercontent.com/bkuhlmann/code_quality/7.0.0/configurations/rubocop/rspec.yml

Now you are configured to import from a global configuration. For further details, see Rubocop Documentation.

Development

To contribute, run:

git clone https://github.com/bkuhlmann/code_quality.git
cd code_quality

Apply changes to any of the configurations files.

Versioning

Read Semantic Versioning for details. Briefly, it means:

  • Major (X.y.z) - Incremented for any backwards incompatible public API changes.

  • Minor (x.Y.z) - Incremented for new, backwards compatible, public API enhancements/fixes.

  • Patch (x.y.Z) - Incremented for small, backwards compatible, bug fixes.

Code of Conduct

Read Code of Conduct for details.

Contributions

Read Contributions for details.

License

Read License for details.

History

Read Changes for details.

Credits

Engineered by Brooke Kuhlmann.