-
Notifications
You must be signed in to change notification settings - Fork 64.5k
fix: improving style guide #31898
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
fix: improving style guide #31898
Conversation
Signed-off-by: Christine <shecoder30@gmail.com>
Automatically generated comment ℹ️This comment is automatically generated and will be overwritten every time changes are committed to this branch. The table contains an overview of files in the Content directory changesYou may find it useful to copy this table into the pull request summary. There you can edit it to share links to important articles or changes and to give a high-level overview of how the changes in your pull request support the overall goals of the pull request.
fpt: Free, Pro, Team |
|
Howdy, @CBID2 👋 ! It looks like you've asked @ethanpalm for assistance on the related issue. I'll go ahead and leaves this PR for now while we wait for his input 💛 thank you for taking this on! |
Thanks @nguyenalex836. You can give feedback too! :) I'm open to your thoughts |
That's very kind of you! 😊 This isn't my area of expertise, and Ethan will be the superior resource - but I appreciate the kind words! 💛 |
ethanpalm
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for creating this PR, @CBID2! Adding this example is helpful since it's a pretty common mixup.
The other changes to close #31686 would be updating lines 1482 and 1483 (unfortunately they're too far from the edited lines so I can't put the comments directly on those lines).
1482: change "Write" to write and "Admin" to admin so that the line reads (e.g. write for a repository, admin for a security advisory)
1483: remove the quotation marks so "team maintainer" becomes team maintainer
Hi @ethanpalm. I made the changes. |
ethanpalm
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks great, @CBID2 😄
I'm going to push one small change to remove the quotation marks around write and admin, then will get this published. It should be live on the Docs site soon.
Thank you for taking the time to help improve the GitHub Docs! 🚀
content/contributing/style-guide-and-content-model/style-guide.md
Outdated
Show resolved
Hide resolved
|
Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours. If you're looking for your next contribution, check out our help wanted issues ⚡ |
Why:
Closes: #31686
What's being changed (if available, include any code snippets, screenshots, or gifs):
This PR adds examples of how not to write content in GitHub's documentation to their style guide.
Check off the following:
I have reviewed my changes in staging, available via the View deployment link in this PR's timeline (this link will be available after opening the PR).
datadirectory.For content changes, I have completed the self-review checklist.