Skip to content

Commit 5a54aae

Browse files
committed
Add MODULE_SELF_EVALUATION.md
1 parent e3e7704 commit 5a54aae

File tree

1 file changed

+50
-0
lines changed

1 file changed

+50
-0
lines changed

MODULE_SELF_EVALUATION.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
## Module 'ui-requests-mediated' Self-Evaluation Checklist
2+
3+
Based on [FOLIO Module Acceptance Values and Criteria version 3.0](https://github.com/folio-org/tech-council/blob/master/MODULE_ACCEPTANCE_CRITERIA.MD)
4+
5+
## Administrative
6+
* [ ] Listed by the Product Council on [Functionality Evaluated by the PC](https://wiki.folio.org/display/PC/Functionality+Evaluated+by+the+PC) with a positive evaluation result.
7+
8+
## Shared/Common
9+
* [ ] Uses Apache 2.0 license (2)
10+
* [ ] Module build MUST produce a valid module descriptor (3, 5)
11+
* _This is not applicable to libraries_
12+
* [ ] Inclusion of third party dependencies complies with [ASF 3rd Party License Policy](https://apache.org/legal/resolved.html) (2)
13+
* Uses README for [Category B Appropriately Labelled Condition](https://apache.org/legal/resolved.html#appropriately-labelled-condition)
14+
* org.z3950.zing:cql-java is allowed if appropriately labelled, even if it is LGPL-2.1-only
15+
* org.marc4j:marc4j is allowed if appropriately labelled, even if it is LGPL-2.1-or-later
16+
* org.hibernate.* is allowed if appropriately labelled, even if it is LGPL-2.1-or-later
17+
* _note: If a library declares multiple licenses in its pom.xml, [only one of them needs to comply](https://maven.apache.org/ref/3.9.11/maven-model/maven.html#project)._
18+
* [ ] Installation documentation is included (11)
19+
* -_note: read more at https://github.com/folio-org/mod-search/blob/master/README.md_
20+
* _This is not applicable to libraries_
21+
* [ ] [Personal data form](https://github.com/folio-org/personal-data-disclosure) is completed, accurate, and provided as PERSONAL_DATA_DISCLOSURE.md file (6)
22+
* _This is not applicable to libraries_
23+
* [ ] Sensitive and environment-specific information is not checked into git repository (6)
24+
* [ ] Written in a language and framework from the [officially supported technologies](https://wiki.folio.org/display/TC/Officially+Supported+Technologies) page[^1] (3, 5)
25+
* [ ] Uses FOLIO interfaces already provided by previously accepted modules _e.g. a UI module cannot be accepted that relies on an interface only provided by a back end module that hasn’t been accepted yet_ (3, 5, 12)
26+
* _This is not applicable to libraries_
27+
* [ ] Must not depend on a FOLIO library that has not been approved through the TCR process
28+
* [ ] Gracefully handles the absence of third party systems or related configuration. (3, 5, 12)
29+
* [ ] Sonarqube hasn't identified any security issues, any high or greater severity issues, or excessive (>3%) duplication (6); and any disabled or intentionally ignored rules/recommendations are reasonably justified.
30+
* See [Rule Customization](https://dev.folio.org/guides/code-analysis/#rule-customization) details.
31+
* [ ] Uses [officially supported](https://wiki.folio.org/display/TC/Officially+Supported+Technologies) build tools (3, 5, 13)
32+
* [ ] Unit tests have 80% coverage or greater, and are based on [officially supported technologies](https://wiki.folio.org/display/TC/Officially+Supported+Technologies)[^1] (3, 4)
33+
* [ ] Assigned to exactly one application descriptor within the FOLIO Community LSP Platform, specified in the Jira task for this module evaluation (3, 5)
34+
* _The FOLIO Community LSP Platform is defined at https://github.com/folio-org/platform-lsp._
35+
* _This can be evaluated by searching application descriptors across the folio-org GitHub organization (considering those applications part of the community platform) and confirming that this module only appears in the application descriptor of the one specified application._
36+
37+
## Frontend
38+
39+
* [ ] For each consumed API `package.json` MUST include the interface requirement in the `"okapiInterfaces"` or `"optionalOkapiInterfaces"` section (3, 5)
40+
* -_note: read more at https://github.com/folio-org/stripes/blob/master/doc/dev-guide.md#the-package-file-stripes-entry_
41+
* [ ] If provided, End-to-end tests must be written in an [officially supported technology](https://wiki.folio.org/display/TC/Officially+Supported+Technologies)[^1] (3, 4)
42+
* -_note: while it's strongly recommended that modules implement integration tests, it's not a requirement_
43+
* -_note: these tests are defined in https://github.com/folio-org/stripes-testing_
44+
* [ ] Have i18n support via react-intl and an en.json file with English texts (8)
45+
* [ ] Have WCAG 2.1 AA compliance as measured by a current major version of axe DevTools Chrome Extension (9)
46+
* [ ] Use the Stripes version of referred on the [Officially Supported Technologies](https://wiki.folio.org/display/TC/Officially+Supported+Technologies) page[^1] (10, 16)
47+
* [ ] Follow relevant existing UI layouts, patterns and norms (10) -_note: read more about current practices at [https://ux.folio.org/docs/all-guidelines/](https://ux.folio.org/docs/all-guidelines/)_
48+
* E.g. Saving state when navigating between apps (or confirming that you'll lose the state)
49+
* For UI links to documentation, there is no rule on where that documentation should be hosted, i.e. docs.folio.org, or wiki.folio.org, or module-specific destinations, as long as it is publicly accessible.
50+
* [ ] Must work in the latest version of Chrome (the supported runtime environment) at the time of evaluation (10)

0 commit comments

Comments
 (0)