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

Separate Markdown Style Guidelines from General Guidelines #51

Open
2 tasks
mcdonnnj opened this issue May 6, 2021 · 0 comments
Open
2 tasks

Separate Markdown Style Guidelines from General Guidelines #51

mcdonnnj opened this issue May 6, 2021 · 0 comments
Labels
documentation This issue or pull request improves or adds to documentation improvement This issue or pull request will add or improve functionality, maintainability, or ease of use

Comments

@mcdonnnj
Copy link
Member

mcdonnnj commented May 6, 2021

💡 Summary

Break out all of the Markdown specific guidelines in style-guide.md into an appropriate languages/markdown section.

Motivation and context

Currently the information in style-guide.md contains plain language guidelines intermixed with Markdown specific guidelines. I believe it would be better served to break out any Markdown specific guidelines into it's own language section. This will make it more obvious where to find the information as well as improving maintainability.

Implementation notes

The PR should be limited to creating a new languages/markdown section and only moving existing Markdown content in style-guide.md to this section. Any additions/modifications to the Markdown guidelines should be kept to their own PRs after this separation.

Acceptance criteria

  • Create the PR
  • Everyone approves the PR
@mcdonnnj mcdonnnj added documentation This issue or pull request improves or adds to documentation improvement This issue or pull request will add or improve functionality, maintainability, or ease of use labels May 6, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation This issue or pull request improves or adds to documentation improvement This issue or pull request will add or improve functionality, maintainability, or ease of use
Projects
None yet
Development

No branches or pull requests

1 participant