https://github.com/the-common/precommit-template

This project provides a common base of pre-commit's configuration file(.pre-commit-config.yaml) that should be easily adaptable for most project's with little modifications.
https://github.com/the-common/precommit-template

pre-commit pre-commit-config template-project

Last synced: 10 months ago
JSON representation

This project provides a common base of pre-commit's configuration file(.pre-commit-config.yaml) that should be easily adaptable for most project's with little modifications.

• Host: GitHub
• URL: https://github.com/the-common/precommit-template
• Owner: the-common
• Created: 2020-10-31T19:26:16.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2025-01-12T18:07:32.000Z (about 1 year ago)
• Last Synced: 2025-03-23T21:22:30.459Z (11 months ago)
• Topics: pre-commit, pre-commit-config, template-project
• Language: Shell
• Homepage: https://gitlab.com/the-common/precommit-template
• Size: 88.9 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSES/CC-BY-SA-4.0.txt

Awesome Lists containing this project

README

          
# The common pre-commit framework configuration template

This project provides a common base of Pre-commit's configuration file(.pre-commit-config.yaml)

that should be easily adaptable for most project's with little modifications.

  

[![The GitLab CI pipeline status badge of the project's `master` branch](https://gitlab.com/the-common/precommit-template/badges/master/pipeline.svg?ignore_skipped=true "Click here to check out the comprehensive status of the GitLab CI pipelines")](https://gitlab.com/the-common/precommit-template/-/pipelines) [![GitHub Actions workflow status badge](https://github.com/the-common/precommit-template/actions/workflows/check-potential-problems.yml/badge.svg "GitHub Actions workflow status")](https://github.com/the-common/precommit-template/actions/workflows/check-potential-problems.yml) [![pre-commit enabled badge](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white "This project uses pre-commit to check potential problems")](https://pre-commit.com/) [![REUSE Specification compliance badge](https://api.reuse.software/badge/gitlab.com/the-common/precommit-template "This project complies to the REUSE specification to decrease software licensing costs")](https://api.reuse.software/info/gitlab.com/the-common/precommit-template)

## How to use

* Copy the [common.pre-commit-config.yaml](common.pre-commit-config.yaml) file to your preferred

  location as .pre-commit-config.yaml

* Download the source code and run [Installer.bash](Installer.bash) program to setup template

  files for desktop environments.  If you specify a directory as argument it will install the

  template file to the directory instead.

## Licensing

Unless otherwise noted([comment headers](https://reuse.software/spec-3.3/#comment-headers)/[REUSE.toml](https://reuse.software/spec-3.3/#reusetoml)), this product is licensed under [the 4.0 International version of the Creative Commons Attribution-ShareAlike License](https://creativecommons.org/licenses/by-sa/4.0), or any of its more recent versions of your preference.

For the attribution requirement, please retain the "This file is based on ..." mention and link to this project.

This work complies to [the REUSE Specification](https://reuse.software/spec/), refer to the [REUSE - Make licensing easy for everyone](https://reuse.software/) website for info regarding the licensing of this product.