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

Introduce max description linter #1328

Open
Ana06 opened this issue Apr 1, 2025 · 1 comment
Open

Introduce max description linter #1328

Ana06 opened this issue Apr 1, 2025 · 1 comment
Assignees
Labels
💎 enhancement It is working, but it could be better 🏃 CI Related to CI

Comments

@Ana06
Copy link
Member

Ana06 commented Apr 1, 2025

Details

Introduce a linter that checks that the description is not longer of a maximum number of characters.

This helps ensuring we follow our wiki documentation:

The description should be short and not include version specific details or other information that is likely to change in a future version.

It also ensures we can display the description nicely in the installer (such as @sara-rn's work in mandiant/flare-vm#672 aims for) and in the Packages wiki page.

This will require adapting some descriptions, shorting them by removing version specific details, authors, or other information that does not describe the main functionality of the tool.

@Ana06 Ana06 added 💎 enhancement It is working, but it could be better 🏃 CI Related to CI labels Apr 1, 2025
@Ana06 Ana06 added this to the FLARE-VM 2025 Q2 milestone Apr 1, 2025
@Ana06
Copy link
Member Author

Ana06 commented Apr 1, 2025

@sara-rn can you suggest MAX description length based on your work on the installer?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
💎 enhancement It is working, but it could be better 🏃 CI Related to CI
Projects
None yet
Development

No branches or pull requests

2 participants