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

Rename action from "C/C++ Lint Action" to "C/C++ Linter" #97

Closed
Tracked by #87
shenxianpeng opened this issue Sep 4, 2022 · 3 comments · Fixed by #100
Closed
Tracked by #87

Rename action from "C/C++ Lint Action" to "C/C++ Linter" #97

shenxianpeng opened this issue Sep 4, 2022 · 3 comments · Fixed by #100
Labels
enhancement New feature or request

Comments

@shenxianpeng
Copy link
Collaborator

shenxianpeng commented Sep 4, 2022

I'm wondering whether to change this action's name in the marketplace from "C/C++ Lint Action" to "C/C++ Linter", because the following reasons.

  1. To improve the ranking (A good action should be known)
    When I search in the marketplace with the keyword "lint", our action is on the first page, but when I search with "linter", the action is on the second page, even though we have a higher start, from the search results, it should be because of not a linter in the name. (see screenshots below)
  2. Word "linter" seems used more than "lint" in the marketplace
  3. The action name and the organization name use the same suffix - linter

I also want to update the action's description

  • From "Automatically checks push & PR changes with clang-format & clang-tidy, then post annotations/comments with faulty results."
  • To "Automatically checks push/pull request changes with clang-format/clang-tidy then post annotations/comments with faulty results."

Because "&" cannot be displayed in the marketplace. Or use the following description from README to make difference with other actions forked from ArtificialAmateur/cpp-linter-action

  • "Linting C/C++ code integrating clang-tidy and clang-format to collect feedback provided in the form of thread comments and/or annotations"

screenshots

Search with "lint", our action is on page 1

image

Search with "linter", on page 1, no our action

image

We are on page 2: https://github.com/marketplace?page=2&q=linter&query=linter&type=actions

image

@shenxianpeng shenxianpeng added the enhancement New feature or request label Sep 4, 2022
@2bndy5
Copy link
Collaborator

2bndy5 commented Sep 4, 2022

Sounds good to me.

Its a bit weird that github doesn't use the repo's keywords/tags to help prioritize the search. Maybe we have so many that it gets confused?
image
Maybe the order of keywords has precedence?

@2bndy5
Copy link
Collaborator

2bndy5 commented Sep 4, 2022

The ampersand (&) is probably because it is an illegal XML character. I'd suggest /, but that has special meaning in XML. We should probably replace the & with and.

@shenxianpeng
Copy link
Collaborator Author

Maybe the order of keywords has precedence?

I have updated the order of keywords. OK, will replace the & with and

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
No open projects
Development

Successfully merging a pull request may close this issue.

2 participants