-
Notifications
You must be signed in to change notification settings - Fork 0
Add copilot instructions and linter workflow #5
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
Merged
Changes from all commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
17f44e3
Add Copilot markdown and post conventions guide
mazino2d 30308cd
docs: Update blog markdown conventions and commit guidelines
mazino2d 74a1ab0
docs: Add markdown files instructions for blog posts
mazino2d 6354ea5
docs: Add GitHub Copilot instructions and commit guidelines
mazino2d 007b1a6
docs: Add markdownlint configuration file for markdown linting rules
mazino2d 9027975
docs: Add GitHub Actions workflow for Markdown linting
mazino2d 22dee4b
docs: Add pre-commit configuration for Markdown linting
mazino2d 9a530a5
docs: Update contact information formatting in aboutme.md
mazino2d 2f445eb
Add pre-commit setup instructions and update workflow
mazino2d File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| # GitHub Copilot Instructions | ||
|
|
||
| ## Git Commit Guidelines | ||
|
|
||
| ### Commit Message Format | ||
|
|
||
| - Use imperative mood in commit messages (e.g., "Add feature" not "Added feature") | ||
| - Start with a verb: Add, Update, Fix, Remove, Refactor, etc. | ||
| - Keep the summary line under 50 characters | ||
| - Use present tense | ||
|
|
||
| ### Commit Message Structure | ||
|
|
||
| ```plaintext | ||
| <type>: <short summary> | ||
|
|
||
| <detailed description (optional)> | ||
| ``` | ||
|
|
||
| ### Types | ||
|
|
||
| - `feat`: New feature or content | ||
| - `fix`: Bug fix or correction | ||
| - `docs`: Documentation changes | ||
| - `style`: Formatting, CSS changes (no code change) | ||
| - `refactor`: Code refactoring | ||
| - `chore`: Maintenance tasks | ||
|
|
||
| ### Examples | ||
|
|
||
| Good commit messages: | ||
|
|
||
| - `feat: Add atomic habits book review post` | ||
| - `fix: Correct typo in classification metrics post` | ||
| - `style: Update post layout spacing` | ||
| - `docs: Update README with setup instructions` | ||
|
|
||
| ### Description Guidelines | ||
|
|
||
| - Explain WHAT changed and WHY (not HOW) | ||
| - Use bullet points for multiple changes | ||
| - Reference issue numbers if applicable | ||
| - Keep it concise but informative |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| --- | ||
| applyTo: "**/*.md" | ||
| --- | ||
|
|
||
| # Markdown Files Instructions | ||
|
|
||
| ## Post Files | ||
|
|
||
| - All blog posts must be placed in `_posts/` directory | ||
| - Use filename format: `YYYY-MM-DD-title.md` (e.g., `2025-12-13-my-post.md`) | ||
| - Always include YAML front matter at the top of each post | ||
|
|
||
| ## YAML Front Matter | ||
|
|
||
| Required fields: | ||
|
|
||
| - `layout: post` | ||
| - `title: "Your Post Title"` | ||
|
|
||
| Optional but recommended: | ||
|
|
||
| - `subtitle: "A brief description"` | ||
| - `tags: [tag1, tag2, tag3]` | ||
| - `comments: true/false` | ||
|
|
||
| ## Content Structure | ||
|
|
||
| - Use clear heading hierarchy (h2, h3, h4) | ||
| - Add blank lines between sections for readability | ||
| - Use code blocks with language specification (e.g., ```python,```javascript) | ||
| - Include alt text for all images | ||
|
|
||
| ## Writing Style | ||
|
|
||
| - Write content in English | ||
| - Keep paragraphs concise and focused | ||
| - Use lists for better readability | ||
| - Add relevant tags for post categorization |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| name: Markdown Lint | ||
|
|
||
| on: | ||
| pull_request: | ||
| paths: | ||
| - "**.md" | ||
| workflow_dispatch: | ||
|
|
||
| permissions: | ||
| contents: read | ||
|
|
||
| jobs: | ||
| lint: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Checkout | ||
| uses: actions/checkout@v4 | ||
|
|
||
| - name: Markdown Lint | ||
| uses: DavidAnson/markdownlint-cli2-action@v16 | ||
| with: | ||
| globs: | | ||
| **/*.md | ||
| !node_modules | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| { | ||
| "default": true, | ||
| "MD003": { | ||
| "style": "atx" | ||
| }, | ||
| "MD007": { | ||
| "indent": 2 | ||
| }, | ||
| "MD013": { | ||
| "line_length": 1000, | ||
| "code_blocks": false, | ||
| "tables": false | ||
| }, | ||
| "MD024": { | ||
| "siblings_only": true | ||
| }, | ||
| "MD033": false, | ||
| "MD041": false | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| --- | ||
| repos: | ||
| - repo: local | ||
| hooks: | ||
| - id: lint-markdown | ||
| name: Lint Markdown files | ||
| entry: npx --yes markdownlint-cli2 | ||
| language: system | ||
| files: \.md$ | ||
| pass_filenames: true |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.