Skip to content

Commit

Permalink
refactor: improve the comments to make them timeless, requiring chang…
Browse files Browse the repository at this point in the history
…es only if the RANK instruction usage changes in `JHipsterModuleRank.java`.
  • Loading branch information
renanfranca committed Jan 23, 2025
1 parent 8653f0d commit ddb7ffb
Showing 1 changed file with 12 additions and 13 deletions.
Original file line number Diff line number Diff line change
@@ -1,36 +1,35 @@
package tech.jhipster.lite.module.domain.resource;

/**
* Represents the maturity and adoption level of JHipster modules.
* Ranks range from experimental to community-validated,
* helping users assess module stability and production readiness.
*/
public enum JHipsterModuleRank {
/**
* Not really usable as is, unless you have good expertise on the subject
* (ex: custom-jhlite)
* Experimental or advanced module requiring specific expertise
*/
RANK_D,

/**
* No known usage on production product
* (ex: vue-core, the current version)
* Module without known production usage
*/
RANK_C,

/**
* One declared usage on production product
* (ex: kipe-authorization)
* Module with at least one confirmed production usage
*/
RANK_B,

/**
* Multiple declared usages on production product, by multiple person, on various projects
* and demonstrated usage on a talk, book or blog post
* (ex: java-base)
* Module with multiple production usages across different projects
* and documented through talks, books or blog posts
*/
RANK_A,

/**
* A and recognized to add some features that are not available otherwise.
* Features must be really unique and this must be recognized by at least 10 person
* with a vote on any social network (GitHub being a social network).
* With those criteria spring-boot-cucumber-mvc is a good candidate (missing votes).
* Production-proven module providing unique features,
* validated by community feedback (10+ endorsements)
*/
RANK_S,
}

0 comments on commit ddb7ffb

Please sign in to comment.