Skip to content

chore: cleanup and formatting#4

Merged
yCodeTech merged 6 commits intomasterfrom
chore/cleanup-and-formatting
Mar 27, 2026
Merged

chore: cleanup and formatting#4
yCodeTech merged 6 commits intomasterfrom
chore/cleanup-and-formatting

Conversation

@yCodeTech
Copy link
Copy Markdown
Owner

This pull request focuses on improving project documentation and configuration files for better clarity, consistency, and formatting. The primary updates include enhancements to the README.md for readability and navigation, clarification of commit message generation, and updates to formatting rules.

Documentation improvements:

  • Added a detailed Table of Contents to README.md for easier navigation and reorganized content for clarity, including more consistent HTML table formatting in rule descriptions.

Commit message and contribution guidelines:

  • Updated .github/instructions/commit-message-generation.instructions.md to clarify the use of custom commit types, especially distinguishing when to use chore, docs, and ci for Copilot instruction files and workflows. Also improved formatting and examples for better guidance.

Formatting and configuration:

  • Modified .prettierrc.json to apply Prettier formatting rules to Markdown (*.md) files in addition to YAML, ensuring consistent formatting across documentation.

- Remove indentation in tables to prevent auto formatting issues where the tr's or td's will be indented exponentially.

- Only add indentation in where it matters for the content to be aligned properly within the table.
- Added some examples to the `chore` type in the table, like editorconfig and prettier.

- Added preferred types for certain changes.
    - `ci` for files in the `.github/workflows` directory.
    - `chore` for Copilot instructions.
@yCodeTech yCodeTech added documentation Improvements or additions to documentation chore PRs for chores and maintenance labels Mar 27, 2026
@yCodeTech yCodeTech merged commit 60d2036 into master Mar 27, 2026
2 checks passed
@yCodeTech yCodeTech deleted the chore/cleanup-and-formatting branch March 27, 2026 05:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

chore PRs for chores and maintenance documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant