Activation

Overview

Virtually all Foundation-hosted projects are expected to strive towards, and ultimately attain, Active  status.  This indicates to potential consumers that the project has reached a level of maturity, both functional and non-functional, that it is suitable for production use.

Initiating Activation

In order for a project to become Active, it must be reviewed and the change formally approved by the PMC of the Program the project is hosted in.

Any project team may initiate this approval process at any time, which involves:

  1. Preparing an information packet demonstrating that they've met the requirements for activation (see below for details)
  2. Submitting the packet to the appropriate PMC mailing list, requesting an activation vote.

Approval Process

Activation votes are performed by the PMC using the Foundation's standard Decision Making - ARCHIVED mechanism, and only after any outstanding questions or clarifications are answered by the project team.

Activation Lifecycle Checklist

The table below presents a consolidated checklist for contributors to drive Projects towards Activation (all Projects are required to work towards Active state or ultimately be Archived) and for PMC facing an Activation vote:


Activation (promotion to Active State)


What it means for consumers?The Project is high quality, mature from a codebase and community dynamics perspective. The Project produces valuable releases to solve a useful business problem for our Community. 
What it means for the Project Team?

Glory in the Community (smile) 

Increased visibility and positioning in FINOS web resources, marketing and Community building efforts like meetups, blog posts, etc. 

QUALITY & SECURITY

Development Process


The Project adopts best-of-breed standards of distributed software development, including but not limited to:

  • semantic versioning
  • tagging / branch protection
  • continuous integration ("CI") and continuous delivery ("CD") where applicable

If Project Team choses not to use the FINOS provided Open Developer Platform (ODP), a comparable SDLC should be adopted and made available.

Build & Release

The Project code/documentation release process automated or at lest well documented.

If code is published, publicly redistributed release binaries should be listed or referred to in the documentation (e.g. under the FINOS namespace in an artefact repository or package manager, e.g. NPM, Maven Central, etc.)

Security

  • No OWASP Top 10 warnings are present in the code
  • No long-standing medium or higher vulnerabilities (2+ months) and proper security disclosure processes

  • Any cryptographic functions and key lengths used within the software should be identified and vetted with Foundation's legal counsel in order to request compliance with U.S. Export policy.

Read more about FINOS Security vulnerabilities responsible disclosure and how to automate scanning with WhiteSource.

Documentation

The README.md must include or reference up to date:

  • end user docs, including a description of the software, feature overview, installation & configuration instructions
  • developer docs, including links to other external systems (further docs, wiki, CI & validation tools, artefact repository, change log / history, etc.)
  • where possible badges (e.g. from shields.io) are encouraged
  • sample code explaining how to use the project, library, standard, SDK, etc.

DIVERSITY & VIABILITY

CommunityProject has active participation from 2+ independent individuals and/or organizations; Ideally Project Team members who make contributions in connection with their employment are doing do as part of their regular job duties.
Project TeamProject Team has/have demonstrated active involvement in PMC and have demonstrated commitment to furthering overall Program goals

License

Project must not have dependencies which effectively restrict how the project may be distributed or deployed and must not depend on any proprietary third-party components for their core functionality.
TrademarkCommunity is using a different established Project name or original contribution trademark is owned by FINOS. All Project related websites and assets are owned and hosted by FINOS.

ROADMAP & RESOURCES

ProgressProject has progressed against its public roadmap during incubation; roadmap is aligned with, and where applicable incorporated into, the overall program roadmap or backlog
VersioningProject software is production grade and ready for large scale consumption. 1.0.0 version was released and announced it to the announce@ mailing list.
RoadmapProjects share and work to a public roadmap, aligned with the overall program roadmap.
FINOS SupportProject Team is largely self-sufficient, requiring minimal operational support from FINOS to govern the maintain the project. FINOS support switches to strategic growth of the Project in the Community.

GROWTH & ADOPTION

UsefulnessThe Project demonstrably solves a real life use case in the Community. Evidence of adoption beyond the contributing individuals or firms (e.g., in the form of download statistics, listing known deployments or implementations, etc.)
Status BadgingProject Team commits to adopt the FINOS Active badge in the README.md once PMC approves activation properly signal adopters the new state of the Project

HYGIENE & OPERATIONS

ComplianceThe appropriate license text is included in each source file's header. See details and template 
Community InquiriesCommunity inquiries on the project channels (mailing lists, issues and pull requests, etc) are generally promptly answered
Meeting HygieneIf the project meets regularly on-line, the Project Team has demonstrated a track record of publishing and distributing agenda no less than 24 hours before the meeting, and publishes meeting minutes after calls.
TransparencyProject Team has adopted a transparent governance model(*) consistent with FINOS Community governanceWork for new contributors is organized into issues within a public issue tracking system, as appropriate, tagged as "Good First Issues"

(*) transparent governance model is when a project‚Äôs discussions, minutes, deliberations, project plans, issue tracking plans for new features, and other artefacts are open, public, and easily accessible in the FINOS Project Infrastructure or FINOS sanctioned external system.