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

Level up README and related markdown content #64

Closed
3 of 9 tasks
dblock opened this issue Jun 24, 2021 · 1 comment · Fixed by #4416
Closed
3 of 9 tasks

Level up README and related markdown content #64

dblock opened this issue Jun 24, 2021 · 1 comment · Fixed by #4416
Assignees
Milestone

Comments

@dblock
Copy link
Member

dblock commented Jun 24, 2021

Level up and cleanup markdown content.

See .github#8 for details and recommendations, and common-utils for an example.

  • README.md
  • CONTRIBUTING.md
  • DEVELOPER_GUIDE.md
  • MAINTAINERS.md
  • ADMINS.md
  • SECURITY.md
  • RELEASING.md
  • TESTING.md
  • other .md files
@dblock dblock added xx-documentation Improvements or additions to documentation enhancement New feature or request v1.0.0 labels Jun 24, 2021
@aetter aetter added low priority and removed xx-documentation Improvements or additions to documentation v1.0.0 labels Jun 24, 2021
@hdhalter hdhalter added Usability and removed enhancement New feature or request labels May 25, 2022
@hdhalter hdhalter added this to the 2022-Q3 milestone May 25, 2022
@hdhalter hdhalter self-assigned this May 25, 2022
@hdhalter
Copy link
Contributor

Hi @dblock, thanks for posting this issue in the documentation repo! Is this a general request to make sure the content in these files is using the right standards and code of conduct? If so, we can certainly review each file. We are in the process of rewriting the readme.md and contributing.md, and there is another issue open for editing the maintainers.md, so we will make sure to follow the standards.

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

Successfully merging a pull request may close this issue.

5 participants