You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The project website MUST succinctly describe what the software does (what problem does it solve?). [description_good]
Details: This MUST be in language that potential users can understand (e.g., it uses minimal jargon).
✅
The project website MUST provide information on how to: obtain, provide feedback (as bug reports or enhancements), and contribute to the software. [interact]
The information on how to contribute MUST explain the contribution process (e.g., are pull requests used?) {Met URL} [contribution]
Details: We presume that projects on GitHub use issues and pull requests unless otherwise noted. This information can be short, e.g., stating that the project uses pull requests, an issue tracker, or posts to a mailing list.
Rationale: Contributors need to understand not only how to contribute, but also the overall contribution process, so that they'll understand how their work could be incorporated and what the expectations are after the initial submission. Note that criterion "interact" requires that the contribution information be on the project website.
The information on how to contribute SHOULD include the requirements for acceptable contributions (e.g., a reference to any required coding standard). {Met URL} [contribution_requirements]
The software produced by the project MUST be released as FLOSS. [floss_license]
Details: FLOSS is software released under licenses that meet the Open Source or Free Software definitions. Examples include MIT, Apache 2.0, GPL, etc. The software may also have other license options.
- [x]
FLOSS license
It is SUGGESTED that any required license(s) for the software produced by the project be approved by the Open Source Initiative (OSI). [floss_license_osi]
Details: OSI-approved licenses are widely recognized. Unusual licenses can cause long-term issues.
Rationale: OSI approval ensures a well-understood, standard license.
- [x]
FLOSS license
The project MUST post the license(s) of its results in a standard location in their source repository. {Met URL} [license_location]
Details: Typically a top-level LICENSE or COPYING file. Encourages clarity on project licensing.
The project MUST provide basic documentation for the software produced by the project. [documentation_basics]
Details: Includes instructions on installation, starting, usage, and secure usage, if appropriate. Users need documentation to learn how to use the software effectively.
The project MUST provide reference documentation that describes the external interface of the software produced by the project. [documentation_interface]
Details: Document APIs, command-line parameters, or REST interfaces clearly so they can be understood without reading the entire source code.
- [x]
Other
The project sites (website, repository, and download URLs) MUST support HTTPS using TLS. [sites_https]
Details: Using HTTPS protects against man-in-the-middle attacks. If HTTP is used, it should redirect to HTTPS.
Goal:
As a
<stakeholder|persona>I want to
so that
Acceptance Criteria:
Complexity: <High|Medium|Low> > A short comment to remind the reason for the rating
Uncertainty: <High|Medium|Low> > A short comment to remind the reason for the rating
Tasks:
Details: This MUST be in language that potential users can understand (e.g., it uses minimal jargon).
https://github.com/mojaloop/mojaloop/blob/main/contribute/Reporting-Bugs.md
Details: We presume that projects on GitHub use issues and pull requests unless otherwise noted. This information can be short, e.g., stating that the project uses pull requests, an issue tracker, or posts to a mailing list.
Rationale: Contributors need to understand not only how to contribute, but also the overall contribution process, so that they'll understand how their work could be incorporated and what the expectations are after the initial submission. Note that criterion "interact" requires that the contribution information be on the project website.
https://docs.mojaloop.io/community/standards/creating-new-features.html
https://docs.mojaloop.io/community/standards/creating-new-features.html
Details: FLOSS is software released under licenses that meet the Open Source or Free Software definitions. Examples include MIT, Apache 2.0, GPL, etc. The software may also have other license options.
Details: OSI-approved licenses are widely recognized. Unusual licenses can cause long-term issues.
Rationale: OSI approval ensures a well-understood, standard license.
Details: Typically a top-level LICENSE or COPYING file. Encourages clarity on project licensing.
https://docs.mojaloop.io/community/
https://docs.mojaloop.io/product/
https://docs.mojaloop.io/technical/
https://docs.mojaloop.io/technical/technical/deployment-guide/
https://github.com/mojaloop/iacv2-docs
Details: Includes instructions on installation, starting, usage, and secure usage, if appropriate. Users need documentation to learn how to use the software effectively.
Details: Document APIs, command-line parameters, or REST interfaces clearly so they can be understood without reading the entire source code.
Details: Using HTTPS protects against man-in-the-middle attacks. If HTTP is used, it should redirect to HTTPS.
https://github.com/mojaloop/mojaloop-specification/issues
https://github.com/mojaloop/design-authority-project/issues
https://github.com/mojaloop/project/issues
Slack invite link
Details: Acceptable mechanisms include mailing lists, GitHub issues, etc. Proprietary clients aren't required.
Details: English is the lingua franca of technology, enabling more worldwide collaboration.
Done
Pull Requests:
Follow-up:
Dependencies:
Accountability:
The text was updated successfully, but these errors were encountered: