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.

Sign up for GitHub

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

Jump to bottom

Update Readme check to include missing plugin header #402

Closed
ernilambar opened this issue Jan 24, 2024 · 6 comments
Closed

Update Readme check to include missing plugin header #402

ernilambar opened this issue Jan 24, 2024 · 6 comments
Labels
Checks Audit/test of the particular part of the plugin [Team] Plugin Review Issues owned by Plugin Review Team [Type] Enhancement A suggestion for improvement of an existing feature
Milestone
1.0.2

Comments

@ernilambar
Copy link
Member

ernilambar commented Jan 24, 2024 •
edited
Loading

Related: #198

In current readme validator, warnings are raised if following fields are missing:

  • Tested up to
  • Stable tag
  • Contributors

We could also implement here in trunk a similar parity with the current readme validator.

Ref:

Screenshot 2024-01-25 at 4 08 59 PM
@ernilambar
Copy link
Member Author

@ernilambar ernilambar mentioned this issue Feb 5, 2024
Merged
@swissspidy
Copy link
Member

#414 seems fine at first glance, but I recommend asking the plugin review team whether it's useful for them
@ernilambar
Copy link
Member Author

@foosantos We have already implemented missing Stable Tag. Would it be helpful if we also implement missing Tested up to and Contributors? By default contributor_ignored warning is ignored, so missing Contributors won't be warned.
@foosantos
Copy link
Member

cc @bordoni
@ernilambar ernilambar mentioned this issue Feb 9, 2024
Closed
1 task
@davidperezgar
Copy link
Member

Yes, we have to check that the plugin has a correct readme.
@swissspidy swissspidy added [Type] Enhancement A suggestion for improvement of an existing feature Checks Audit/test of the particular part of the plugin labels Mar 26, 2024
@davidperezgar davidperezgar added the [Team] Plugin Review Issues owned by Plugin Review Team label Jun 21, 2024
@ernilambar
Copy link
Member Author

Fixed in #414
@ernilambar ernilambar added this to the 1.1.0 milestone Jul 3, 2024
@swissspidy swissspidy modified the milestones: 1.1.0, 1.0.2 Jul 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Checks Audit/test of the particular part of the plugin [Team] Plugin Review Issues owned by Plugin Review Team [Type] Enhancement A suggestion for improvement of an existing feature
4 participants
@swissspidy @ernilambar @davidperezgar @foosantos