Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Activating Waltz in FINOS Foundation #4872

Closed
mcleo-d opened this issue May 15, 2020 · 6 comments · Fixed by #4990
Closed

Activating Waltz in FINOS Foundation #4872

mcleo-d opened this issue May 15, 2020 · 6 comments · Fixed by #4990
Assignees
Labels
FINOS Activation noteworthy probably worth mentioning in release notes task Not directly feature related (i.e. dependency upgrade, docs, etc)

Comments

@mcleo-d
Copy link
Member

mcleo-d commented May 15, 2020

Description of Waltz Activation Criteria

Virtually all FINOS 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.

This epic has been created to present the activation requirements in the table below and to collect the materials needed to activate Waltz as an individual, or series of, linked issues.

A full description of FINOS project activation is linked and found in the table below.

Activation (promotion to Active State) How and Where Demonstrated
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
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.
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
Community Project 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 Team Project Team has/have demonstrated active involvement in PMC and have demonstrated commitment to furthering overall Program goals
  • No longer required
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.
Trademark Community 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
Progress Project has progressed against its public roadmap during incubation; roadmap is aligned with, and where applicable incorporated into, the overall program roadmap or backlog
Versioning Project software is production grade and ready for large scale consumption. 1.0.0 version was released and announced it to the announce@ mailing list.
Roadmap Projects share and work to a public roadmap, aligned with the overall program roadmap.
FINOS Support Project 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
Usefulness The 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 Badging Project 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
  • @davidwatkins73 confirms FINOS Active badge can be added to Waltz README.MD
HYGIENE & OPERATIONS
Compliance The appropriate license text is included in each source file's header. See details and template
Community Inquiries Community inquiries on the project channels (mailing lists, issues and pull requests, etc) are generally promptly answered
Meeting Hygiene If 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.
Transparency Project Team has adopted a transparent governance model(*) consistent with FINOS Community governance. Work 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.

@davidwatkins73 davidwatkins73 added noteworthy probably worth mentioning in release notes task Not directly feature related (i.e. dependency upgrade, docs, etc) labels May 15, 2020
@mcleo-d
Copy link
Member Author

mcleo-d commented May 20, 2020

Hi @davidwatkins73 👋

It'll be great to schedule a call to start breaking this epic into the stories that are complete and can be demonstrated now ... and then ... the stories we need to complete to deliver the epic this quarter.

Let me know your thoughts on dates and times.

James.

@davidwatkins73
Copy link
Member

How about tomorrow afternoon ? Free most of the time.

@mcleo-d
Copy link
Member Author

mcleo-d commented Jun 2, 2020

@davidwatkins73 and @maoo - I have tagged you both in the Security section of the activation criteria to confirm everything in this area is expected. Please check the box in this section when you're both happy this criteria has been met 👍

@mcleo-d
Copy link
Member Author

mcleo-d commented Jun 8, 2020

@mcleo-d
Copy link
Member Author

mcleo-d commented Jul 6, 2020

@mindthegab and @maoo - Waltz's Activation in FINOS is now Ready for Review by the FINOS team. Please feel free to feedback to @davidwatkins73 and @mcleo-d 👍

@mindthegab
Copy link
Member

@davidwatkins73 and @mcleo-d - thank you so much for such a thorough documentation and review of our lifecycle. /cc @brooklynrob @toshaellison and @maoo as this is an amazing example of a well documented activation.

I am happy to confirm Waltz is ready to become an active project (and we will announce it our next marketing cycle /cc @grizzwolf).

Simply merge #4990 to get the badge and contextually close this issue.

Congratulations!

davidwatkins73 added a commit that referenced this issue Jul 10, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
FINOS Activation noteworthy probably worth mentioning in release notes task Not directly feature related (i.e. dependency upgrade, docs, etc)
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants