Standardize Markdown formatting across documentation #271#283
Standardize Markdown formatting across documentation #271#283HackersSpirit wants to merge 1 commit intoOpenSource-Communities:mainfrom
Conversation
There was a problem hiding this comment.
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
|
Hey @HackersSpirit, 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 Note: Please follow the Markdown best practices when you update the Markdown formats in all Please let us know if you have any questions. Thanks. |
|
Thanks for letting me know |
This PR addresses issue #271 by standardizing Markdown formatting in the documentation files.
Changes include:
All acceptance criteria from the issue have been met.