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

Feat: documentation or docs label? #141

Closed
nelsonic opened this issue Sep 29, 2022 · 4 comments
Closed

Feat: documentation or docs label? #141

nelsonic opened this issue Sep 29, 2022 · 4 comments
Labels
discuss Share your constructive thoughts on how to make progress with this issue enhancement New feature or enhancement of existing functionality question A question needs to be answered before progress can be made on this issue starter A beginner-friendly issue that is a good starting point for a new person T5m Quick tasks that take 5 mins or less. See: GTD 2 min rule.

Comments

@nelsonic
Copy link
Member

At present some of our repos have a documentation label
e.g: https://github.com/dwyl/app/labels/docs or github.com/iteles/blw-baby/issues?q=label%3Adocumentation
and it's mentioned hundreds of times across the org:
https://github.com/search?q=org%3Adwyl+documentation

But this (labels) repo doesn't have it for some reason ...
I feel that it is useful in many situations and should be one of our default labels.

Question / Decision: documentation or docs ?

Should the label be documentation or docs?

I tend to favour the more verbose documentation because it's clearer to newcomers.
But the docs shorter version is more concise and has the same meaning to most people.

Thoughts? 💭

@nelsonic nelsonic added enhancement New feature or enhancement of existing functionality question A question needs to be answered before progress can be made on this issue discuss Share your constructive thoughts on how to make progress with this issue starter A beginner-friendly issue that is a good starting point for a new person T5m Quick tasks that take 5 mins or less. See: GTD 2 min rule. labels Sep 29, 2022
@nelsonic
Copy link
Member Author

Proposed:

  • label: documentation
  • color: #0075ca
  • description: Improvements or additions to documentation

This matches the default documentation label that is included by GitHub on all new repos.
e.g. a recently created repo: https://github.com/dwyl/learn-tailwind
includes the (GitHub default) documentation label: https://github.com/dwyl/learn-tailwind/labels
github-learn-tailwind-documentation-lable

Detail:
image

Any objections or alternative suggestions?

@nelsonic
Copy link
Member Author

- [`documentation`](https://github.com/dwyl/labels/issues/141) `#0075ca` - 
  Improvements or additions to documentation

@nelsonic
Copy link
Member Author

PR: #142

@nelsonic
Copy link
Member Author

Synched and used in: dwyl/decache#29

SimonLab added a commit that referenced this issue Sep 29, 2022
…-issue-#141

PR: add `documentation` label description to README.md closes #141
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
discuss Share your constructive thoughts on how to make progress with this issue enhancement New feature or enhancement of existing functionality question A question needs to be answered before progress can be made on this issue starter A beginner-friendly issue that is a good starting point for a new person T5m Quick tasks that take 5 mins or less. See: GTD 2 min rule.
Projects
None yet
Development

No branches or pull requests

1 participant