To exit incubation, as project must have Sufficient user documentation
The project must including enough documentation for anyone to test or deploy any of the modules.
...
Requirements for BEST PRACTICE BADGE :
The project MUST have a version-controlled source repository that is publicly readable and has a URL. [repo_public] Show detailsMirror Repository on GitHub, which provides public git repositories with URLs. Source control via GitHub
The project's source repository MUST track what changes were made, who made the changes, and when the changes were made. [repo_track]Repository on GitHub, which uses git. git can track the changes, who made them, and when they were made. Source control via GitHub Repository on GitHub, which uses git. git can track the changes, who made them, and when they were made. Repository on GitHub, which uses git. git can track the changes, who made them, and when they were made.
To enable collaborative review, the project's source repository MUST include interim versions for review between releases; it MUST NOT include only final releases. [repo_interim] Show detailsSource control via GitHub
It is SUGGESTED that common distributed version control software be used (e.g., git) for the project's source repository. [repo_distributed] Show detailsMirror repository on GitHub, which uses git. git is distributed. Repository on GitHub, which uses git. git is distributed.
Basics: | ||
---|---|---|
|
|
|
|
|
|
|
|
|
|
|
| |
|
|
|
| |
|
|
|
Hyperledger Explorer Discussion Group
|
(Advanced) What other users have additional rights to edit this badge entry? Currently: []
Change Control | ||
Public version-controlled source repository |
Met
Unmet
?
The project MUST have a version-controlled source repository that is publicly readable and has a URL. [repo_public] Show details |
Unmet
?
The project's source repository MUST track what changes were made, who made the changes, and when the changes were made. [repo_track] |
Unmet
?
To enable collaborative review, the project's source repository MUST include interim versions for review between releases; it MUST NOT include only final releases. [repo_interim] Show details |
Unmet
?
It is SUGGESTED that common distributed version control software be used (e.g., git) for the project's source repository. [repo_distributed] Show details | |
Unique version numbering |
Met
Unmet
?
|
Met
Unmet
?
|
Met
Unmet
?
It is SUGGESTED that projects identify each release within their version control system. For example, it is SUGGESTED that those using git identify each release using git tags. [version_tags] | |
Release notes |
Unmet
N/A
?
The project MUST provide, in each release, release notes that are a human-readable summary of major changes in that release to help users determine if they should upgrade and what the upgrade impact will be. The release notes MUST NOT be the raw output of a version control log (e.g., the "git log" command results are not release notes). Projects whose results are not intended for reuse in multiple locations (such as the software for a single website or service) AND employ continuous delivery MAY select "N/A". (URL required) [release_notes] |
Met
Unmet
N/A
?
The release notes MUST identify every publicly known vulnerability with a CVE assignment or similar that is fixed in each new release, unless users typically cannot practically update the software themselves. If there are no release notes or there have been no publicly known vulnerabilities, choose "not applicable" (N/A). [release_notes_vulns] | ||
REPORTING | ||
---|---|---|
Bug-reporting process | ||
Vulnerability report process | ||
Quality | ||
Working build system | ||
Automated test suite | ||
New functionality testing | ||
Warning flags | ||
Security | ||
Secure development knowledge | ||
Use basic good cryptographic practices | ||
Secured delivery against man-in-the-middle (MITM) attacks | ||
Other security issues | ||
Static code analysis | ||
Dynamic code analysis | ||
Example : Explorer
Best practices
...
- Wiki space Maintenance
- Github or Gerrit repositories
- Graphic Set
- Whitepaper
- Training Documentation Packet
- Diverse group of Maintainers
Project | |
---|---|
Templates Resource Checklist:
...