Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add some costomized format check #98

Open
andy840119 opened this issue Mar 1, 2024 · 1 comment
Open

Add some costomized format check #98

andy840119 opened this issue Mar 1, 2024 · 1 comment
Labels
enhancement New feature or request

Comments

@andy840119
Copy link
Member

andy840119 commented Mar 1, 2024

For all MD:

  • Should be UTF-8 and Space should be 4.

For the changelog:

  • Folder name should be yyyy.mmdd
  • content name should be index.md
  • Should fill the metadata, and the title should be. Title, date and folder name should be matched.
    title: "yyyy.mmdd"
    date: yyyy-mm-dd
    
  • All changelog title should be with h2
  • Customized link should be with target format. (e.g. [karaoke](#2154@andy840119)).
    • If not follow the format, should be the relative link or absolute url
  • Relative link or absolute link should not be 404
  • Customized tag should be with target wording. (e.g. [Close duplicated])
  • (Optional) spell or grammar check.
@andy840119 andy840119 added the enhancement New feature or request label Mar 1, 2024
@andy840119
Copy link
Member Author

Guess should be OK to add some code in the project?
But the code should be cross-platform and might be able to trigger before commit, and should be available trigger in the CI.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant