Skip to content

Standardize Markdown formatting across documentation #271#283

Closed
HackersSpirit wants to merge 1 commit intoOpenSource-Communities:mainfrom
HackersSpirit:main
Closed

Standardize Markdown formatting across documentation #271#283
HackersSpirit wants to merge 1 commit intoOpenSource-Communities:mainfrom
HackersSpirit:main

Conversation

@HackersSpirit
Copy link
Copy Markdown

This PR addresses issue #271 by standardizing Markdown formatting in the documentation files.

Changes include:

All acceptance criteria from the issue have been met.

Copy link
Copy Markdown

@github-actions github-actions Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PR Compliance Checks

Thank you for your Pull Request! We have run several checks on this pull request in order to make sure it's suitable for merging into this project. The results are listed in the following section.

Issue Reference

In order to be considered for merging, the pull request description must refer to a specific issue number. This is described in our Contributing Guide.
This check is looking for a phrase similar to: "Fixes #XYZ" or "Resolves #XYZ" where XYZ is the issue number that this PR is meant to address.

Protected Branch

In order to be considered for merging, the pull request changes must not be implemented on the "main" branch. This is described in our Contributing Guide. We would suggest that you close this PR and implement your changes as described in our Contributing Guide and open a new pull request.

Conventional Commit PR Title

In order to be considered for merging, the pull request title must match the specification in conventional commits. You can edit the title in order for this check to pass.
Most often, our PR titles are something like one of these:

  • docs: correct typo in README
  • feat: implement dark mode"
  • fix: correct remove button behavior

Linting Errors

  • Found type "null", must be one of "feat","fix","docs","style","refactor","perf","test","build","ci","chore","revert"
  • No subject found

@adiati98
Copy link
Copy Markdown
Collaborator

adiati98 commented Oct 3, 2025

Hey @HackersSpirit,
Thank you for taking on this! We appreciate your contribution. ✨

However, we're closing this PR with the following reasons:

You need to create a new branch before you're working on changes, and if you make a PR, don't delete the PR template. Please follow the instructions in the PR template about what you need to fill in each section.

For the next, please be aware of the warning bots and address them accordingly.


I've screened your PR, and it's off to a good start!

However, we do have a "Using Markdown for This Project" section in our contributing guidelines, which basically our style guide.

You can either review the content there and update it when necessary or create a new file called style-guide.md in the contributing file, move the content there, and update when you see fit.

Note: Please follow the Markdown best practices when you update the Markdown formats in all .md files in docs/ directory.

Please let us know if you have any questions. Thanks.

@adiati98 adiati98 closed this Oct 3, 2025
@HackersSpirit
Copy link
Copy Markdown
Author

Thanks for letting me know

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants