Skip to content

Modernize Template - #25

Merged
pascal-zarrad merged 10 commits into
mainfrom
feature/modernize-template
Mar 30, 2026
Merged

pascal-zarrad merged 10 commits into
mainfrom
feature/modernize-template

Conversation

@pascal-zarrad

Copy link
Copy Markdown
Member

Description

This pull request introduces several improvements to project configuration, documentation, and repository standards. The main focus is on enhancing consistency, maintainability, and security practices across the repository. Key updates include a revamped README, improved commit and branch validation, new security policy documentation, and updated configuration files for tooling.

Repository standards and documentation:

  • Updated README.md with clearer instructions, improved badge layout, and details about repository features such as commit conventions, branch validation, and dependency management.
  • Added a new SECURITY.md file outlining the security policy, reporting process, and response timeline.
  • Added a global code ownership rule to .github/CODEOWNERS to assign ownership to the maintainers team.
  • Updated the copyright in LICENSE to include "2022-present".

Tooling and configuration improvements:

  • Replaced commitlint.config.cjs with a new commitlint.config.mjs using modern syntax, expanded commit type validation, and a note for extending scopes. [1]R1, [2]
  • Updated .editorconfig for improved formatting consistency across file types, including new rules for JSON, JS/TS, and shell scripts.
  • Updated .github/renovate.json to use the recommended Renovate configuration for dependency updates.

CI/CD and workflow enhancements:

  • Improved .github/workflows/git.yml by switching to native shell validation for branch names, updating commitlint action versions, and refining workflow permissions and conditions.

Replace deepakputhraya/action-branch-name (unmaintained since 2023,
pinned to @master) with a native shell regex check. Update
actions/checkout to v4 and commitlint-github-action to v6. Fix branch
name regex typo (0-0 → 0-9), add least-privilege permissions, remove
stale develop branch reference.
Convert from CommonJS to ESM, add sec type for security-related
commits, and explicitly define all allowed commit types.
Add indent rules for JS/TS/CSS/Astro/JSON, align shell scripts with
2-space indent to match org standard, and simplify structure.
Add SECURITY.md with vulnerability reporting process and response
timeline. Add CODEOWNERS assigning oss-maintainers as default reviewers.
config:base is a deprecated alias for config:recommended.
Add centered badges with license badge, replace tbd placeholder with
template usage instructions, clean up link references, and update
copyright year.
@pascal-zarrad pascal-zarrad self-assigned this Mar 29, 2026
@pascal-zarrad pascal-zarrad added the C3 - enhancement A change or improvement of a existing feature label Mar 29, 2026
Update LICENSE copyright to 2026, bump actions/checkout to v6, and
simplify SECURITY.md response timeline to 5 days.
@pascal-zarrad
pascal-zarrad merged commit c8d6738 into main Mar 30, 2026
1 of 2 checks passed
@pascal-zarrad
pascal-zarrad deleted the feature/modernize-template branch March 30, 2026 18:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

C3 - enhancement A change or improvement of a existing feature

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant