di-sukharev / di-sukharev/opencommit

[Doc]: Allow global configuration of commit rules via Commitlint/Conventional Commit

Open
#509 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
7.5k
Forks
445
Avg merge
18m
Merged PRs (30d)
2

Description

Description

Document the use of a global Commitlint configuration file (e.g., ~/.commitlintrc.js), so that Conventional Commit rules are applied to all projects, even when there is no local configuration.

Suggested Solution

OpenCommit should read the COMMITLINT_CONFIG environment variable and prioritize the global Commitlint configuration if there is no local configuration, ensuring automatic standardization of commit messages across all user projects. Include in the README a step-by-step guide on how to create, export, and use the global configuration.

Alternatives

Alternatives include creating symlinks to the global file in each project or maintaining bootstrap scripts for new repositories, but these require manual maintenance and do not scale well for multiple teams.

Additional Context

The same workflow should work for both the @commitlint module and the conventional-commit module, as long as the configured preset is @commitlint/config-conventional. Document the limitations and differences between the modules to avoid confusion.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the @commitlint and conventional-commit integration entry points, then review the README documentation structure. Verify how COMMITLINT_CONFIG and local configuration are expected to interact before defining the global fallback behavior. Done means both modules support the requested configuration workflow and the README explains setup, export steps, limitations, and differences.

Written by the indexing model from the issue text.

Assessment

Tech stack
git, javascript
Domain
cli, documentation, tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.