Software Project Contribution and Onboarding - Symphony BDK generator

[symphony-youness]

Business Problem

The BDK Generator allows creating a simple working template project for the Symphony BDK Java or Python and the Workflow Developer Kit (WDK)

Proposed Solution

The BDK generator helps you generate a starting template project including example code, minimal working configuration, and a set of public and private keys.

Current State

The generator source code is on the master branch of the repository. It automatically fetches a the BDK or WDK latest version. The latest release is: yo symphony 2.4.0 It is released under MIT licence.

Existing Materials

Current official repository: https://github.com/SymphonyPlatformSolutions/generator-symphony Using the generator is extremely simple and is described in the README.

Development Team

Leadership

• Olivier Poupeney, Symphony, Engineering Owner, olivier.poupeney@symphony.com, GitHub: opoupeney (maintainer)
• Darlys Maldonado, Symphony, Engineering Owner, darlys.maldonado@symphony.com, GitHub: symphonydarlys (maintainer)
• Youri Bonnaffé, Symphony, Lead, youri.bonnaffe@symphony.com, GitHub: symphony-youri (maintainer)
• Elias Croze, Symphony, Lead, elias.croze@symphony.com, GitHub: symphony-elias (maintainer)
• Thibault Pensec, Symphony, Lead, thibault.pensec@symphony.com, GitHub: symphony-thibault (maintainer)
• Soufiane Aourinmouche, Symphony, Developer, soufiane.aourinmouche@symphony.com, Github: symphony-soufiane (maintainer)

Contribution process (v. 1.0, last updated on October 2, 2020)

Below is the list of tasks that FINOS Team and the contribution author go through in order to complete the FINOS contribution process. Please do not edit these contents at contribution time!

FINOS Contrib POC

• [x] Identify and Assign FINOS Project Coordinator - @Julia-Ritter
• [x] Identify and Assign FINOS Strategic Advisor - @mindthegab

Kick-off meeting

• [x] Set up kick-off meeting with project leads to review:
  • [x] FINOS overview (if necessary)
  • [x] FINOS Maintainers cheatsheet
• [x] Discuss project proposal

Proposal (Lead Maintainer)

• [x] Lead maintainer to send out announcement to community@finos.org using this template:

  Dear FINOS Community, 
  
  We would like to propose a new FINOS project. Please review the proposal details at (_TODO: add link to the GitHub issue proposal_).
  
  If you're interested in participating, please :+1: the GitHub issue proposal and drop a comment with your name, org and email
  
  Thanks a lot,

Identify project meta (Lead: FINOS Contrib POC, Support: FINOS Marketing)

• [x] Project Name - Symphony Generator
  • [x] Design new project logo (if applicable)
• [x] Category and sub-category (for FINOS Landscape) - Applications > Symphony Ecosystem landscape
• [x] Existing code or new Github repository - Existing code
• [x] Existing code releases (and which artifact repositories are used) - 22
• [x] Team composition: lead maintainer and other maintainers - see above
• [x] Continuous Integration (existing/yes/no) - Circle CI, planning to migrate to github actions
• [x] Define project slug - symphony-generator

Maintainers, contributors and CLAs (Lead: FINOS Contrib POC, Support: FINOS infra)

• [x] For each maintainer identified in the previous step, collect: the following info:
  • Fullname
  • GitHub username
  • Corporate email address
• [x] Identify other existing contributors (assuming there's a contribution history (eg Git history)
• [x] Check if maintainers and other contributors are all covered by FINOS CLA

Project Communication Channel(s)

• [x] Ask maintainers which communications channels they'd like to use
• Asynchronous
  • [x] GitHub Issues (public)
  • [x] Google Groups - symphony@finos.org
• [x] Link communication channels linked front and center in the project README.md

Code validation (only if code is contributed) (Lead: FINOS Infra)

• [x] The codebase doesn’t have HIGH or CRITICAL CVEs across direct and transitive libraries
• [x] The codebase doesn’t have any unfriendly licenses across direct and transitive libraries
• [x] (optional - if a build system is provided) The build process runs successfully
• [x] finos-admin is Admin of the GitHub repository to transfer
• [x] The codebase doesn’t include any patent or copyright that conflicts with FINOS Governance and bylaws (to be validated with FINOS Legal team)
• [x] Apply project blueprint contents - see ODP docs
  • [x] Ensure that the proper project governance is in the CONTRIBUTING.md file
• [x] All incubating criteria are checked and documented below

Approval (Lead: FINOS Infra)

• [x] Assign issue to Executive Director (@mindthegab) to trigger voting
• [x] FINOS accepts the contribution (and the contribution process can move forward)

Code transfer (Lead: FINOS Infra)

• [x] Check GitHub repository transfer requirements:
  • [x] finos-admin has Admin to all repositories to transfer
  • [x] finos-admin ia allowed to transfer repositories out of the org
  • [x] if the repository is owned by a user (and not an org), the user must be able to transfer the repository to finos-admin
• [x] Transfer all code assets as GitHub repositories under github.com/finos
• [x] Invite GitHub usernames to GitHub FINOS Org
• [x] Create <project-name>-maintainers GitHub team and invite users
• [x] Configure finos-admins (Maintain role) and finos-staff (Triage role) team permissions
• [x] Enable EasyCLA / CLA Bot
• [x] Update Metadata

Infra setup (Lead: FINOS Infra)

• [x] Update release coordinates and code namespace to include finos (best effort)
• [x] Update project badge
• [x] Update project README
• [x] Enable security vulnerabilities scanning
• [x] Aggregate mailing lists to community@finos.org

Metadata update (Lead: FINOS Infra)

• [x] Add project to metadata
• [x] Add project maintainers emails to finos-project-maintainers@finos.org list
• [x] Add project maintainers GitHub usernames to the project-maintainers Team
• [x] Onboard project on LF systems (SFDC, Insights, EasyCLA, Groups.io) - https://jira.linuxfoundation.org/browse/SS-624

Announcement (Lead: FINOS Contrib POC)

• [x] Work with FINOS marketing to send out announcement to announce@finos.org , checkout announcement template at https://finosfoundation.atlassian.net/wiki/spaces/FINOS/pages/83034172/Contribute
• [x] Notify FINOS Contrib POC and FINOS marketing manager once the announcement has been sent out (FINOS infra)\
• [x] Merge PR https://github.com/finos/finos-landscape/pull/123

[symphony-youri]

It is released under MIT licence.

As we are changing it to Apache maybe we'll have to release a new version

[TheJuanAndOnly99]

Announcement sent out to https://groups.google.com/u/1/a/finos.org/g/announce/c/OOwZSct8Pl8. The contribution is now complete, congratulations Symphony team!

/CC @grizzwolf for marketing purposes.