question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Should we adopt a naming convention for labels on the repo?

See original GitHub issue

Currently, on the ^tips opensource command we tell the user they can use a label that doesn’t exist on the repo yet (“command:opensource”): imagem

IMO, creating this label would help filter the list of issues, so that someone that wants to make these sort of changes (tips and advice) can easily find them. Before creating the label, I think we could start thinking about a naming convention on our custom labels.

Examples

For example, Angular seems to have a convention based on defining a type and associating a color to it. Then there is a scope to define the subsection on the type of label (e.g. browser: edge). Note: I tried finding docs explaining this, but I couldn’t. I’m just assuming their convention is sort of based on conventional commits, hence the “type” and “scope” 🙂.

Another example of this idea is on Gitlab on Scoped labels.

You can also check out this article that states the Electron repo uses a similar convention: imagem

Let me know your thoughts on this idea 😃.

Issue Analytics

  • State:closed
  • Created 3 years ago
  • Reactions:4
  • Comments:7 (5 by maintainers)

github_iconTop GitHub Comments

1reaction
mikeysancommented, Dec 17, 2020

Yep. Looks to me like it has been fullfilled.

1reaction
eddiejaoudecommented, Aug 10, 2020

Great idea 👍

Read more comments on GitHub >

github_iconTop Results From Across the Web

Should we adopt a naming convention for labels on the repo?
Currently, on the ^tips opensource command we tell the user they can use a label that doesn't exist on the repo yet ("command:opensource"):...
Read more >
Try a Semantic Approach to Naming GitHub Repositories
Learn how to maintain consistency in naming conventions for GitHub repositories using a semantic approach.
Read more >
Best Practice: Conventions for Object Naming - 7.3
A Naming Convention is a rule to follow when deciding to name objects like a Job, file, context, variable, code routine, metadata, etc....
Read more >
Best Practices for Structuring and Naming Artifactory ... - JFrog
JFrog recommends a four-part naming structure that includes: A project, product or team name as the primary identifier of the project.
Read more >
Is there a naming convention for git repositories?
@AdrianM my point is: yes, a naming convention is useful, but it has nothing to do with Git or GitHub, and everything with...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found