Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/collaboration-infrastructure.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
id: collaboration-infrastructure
title: Collaboration Infrastructure
description: "GitHub-based collaboration for FINOS: CLAs, org access, issues, and workflows that maintainers and contributors use across projects, SIGs, and programs."
---

import useBaseUrl from '@docusaurus/useBaseUrl';
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
id: codeclimate
title: Code Climate
description: "Code Climate metrics for FINOS: coverage, maintainability, and technical debt signals in pull requests to keep project codebases healthy and reviewable."
---

import useBaseUrl from '@docusaurus/useBaseUrl';
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
id: coverityscan
title: Coverity Scan
description: "Coverity static analysis in FINOS builds: find defects in C, C++, and other supported languages before they ship in security-sensitive financial software."
---

import useBaseUrl from '@docusaurus/useBaseUrl';
Expand Down
1 change: 1 addition & 0 deletions docs/development-infrastructure/code-validation/intro.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
id: intro
title: Code Validation
description: "Code validation in FINOS CI: static analysis, coverage, and supply-chain checks that keep security and quality high across GitHub-based repositories."
---

In order to assess Security, Quality and Legal compliance of software hosted by the Foundation, project leads and committers can configure integrations with third-party systems that are provided by the Foundation; the result of these processes can be published in the project's documentation to improve the final consumer experience and when requesting activation.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
id: sonarcloud
title: Sonar Cloud
description: "SonarCloud quality and security analysis for FINOS: continuous inspection of bugs, vulnerabilities, and smells on pull requests and main branches."
---

import useBaseUrl from '@docusaurus/useBaseUrl';
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
id: sonatype
title: Sonatype Lifecycle
description: "Sonatype dependency governance for FINOS: license and policy compliance across your supply chain as projects consume open source in regulated environments."
---

# Sonatype Lifecycle
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
id: whitesource
title: Whitesource
description: "Mend/Whitesource for FINOS: open source license and vulnerability scanning in CI to catch risky dependencies before they reach production financial systems."
---

import useBaseUrl from '@docusaurus/useBaseUrl';
Expand Down
1 change: 1 addition & 0 deletions docs/development-infrastructure/continuous-delivery.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
id: continuous-delivery
title: Continuous Delivery
description: "Continuous delivery for FINOS projects: release automation, safe deployments, and practices that get trusted artifacts to users and downstream systems."
---

import useBaseUrl from '@docusaurus/useBaseUrl';
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
id: clojure
title: Clojure
description: "Continuous integration for Clojure at FINOS: ODP, GitHub Actions, and testing patterns to build, verify, and publish JVM libraries to trusted registries."
---

[**Clojure**](https://clojure.org/) is a dialect of the Lisp programming language that runs on the Java virtual machine, Common Language Runtime, and JavaScript engines; the Foundation hosts [some Clojure projects](https://github.com/finos?q=&type=&language=clojure) that can be browsed as examples.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
id: csharp
title: C#
description: "C# and .NET continuous integration for FINOS: build, test, and release pipelines for managed projects on GitHub in open source financial services."
---

import useBaseUrl from '@docusaurus/useBaseUrl';
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
id: docker
title: Docker Build and Publish
description: "Docker build and publish for FINOS: secure container image pipelines, registries, and best practices for projects shipping services and tools as containers."
---

## Why Docker?
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
id: intro
title: Continuous Integration
description: "Continuous integration for FINOS on GitHub: ODP, automated builds, tests, and quality checks that keep open finance codebases reliable in every language."
---

import useBaseUrl from '@docusaurus/useBaseUrl';
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
id: java
title: Java
description: "Java build and test automation for FINOS: Maven, Gradle, ODP patterns, and quality gates for widely used JVM projects across the open finance stack."
---

import useBaseUrl from '@docusaurus/useBaseUrl';
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
id: javascript
title: Javascript
description: "JavaScript and Node continuous integration for FINOS: npm, yarn, GitHub Actions, and testing for front-end and back-end open source in the foundation."
---

In the last decade, Javascript (JS) has been increasingly used for backend software development, especially since the first appearance of Node.js. Listed below are some of the most common processes that are involved in a Javascript project lifecycle in several JS ecosystems/platforms, and how they interact with the project infrastructure provided by the Foundation.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
id: python
title: Python
description: "Python CI for FINOS: pip, poetry, tox, and GitHub Actions to test and package data and service projects with consistent quality in open finance."
---

[**Python**](https://www.python.org/) is an interpreted, object-oriented, high-level programming language with dynamic semantics. Packages are published on the [Python Package Index (pypi)](https://pypi.python.org/pypi), however the FINOS account is still empty, see [pypi.org/user/finos](https://pypi.org/user/finos/) .
Expand Down
1 change: 1 addition & 0 deletions docs/development-infrastructure/project-documentation.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
id: project-documentation
title: Project Documentation
description: "Publish FINOS project documentation: Docusaurus, GitHub Pages, and patterns for clear docs sites that follow foundation branding and best practices."
---

import useBaseUrl from '@docusaurus/useBaseUrl';
Expand Down
1 change: 1 addition & 0 deletions docs/finos-contributor-cheatsheet.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
id: finos-contributors-cheatsheet
title: FINOS Contributor Cheatsheet
description: "A practical reference for new FINOS contributors: CLAs and EasyCLA, issues and pull requests, Good First Issues, and where to get help."
---

## Contributor License Agreement (CLA) and DCO
Expand Down
12 changes: 6 additions & 6 deletions docs/finos-maintainer-cheatsheet.mdx
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
id: finos-maintainers-cheatsheet
title: FINOS Maintainers Cheatsheet
description: "A practical guide for FINOS maintainers: roles, meetings, CI/CD, documentation, security scanning, and FINOS marketing and operations support."
---

# Welcome
Welcome to the FINOS Maintainers Cheatsheet, the guide for new and experienced [FINOS Maintainers](https://github.com/finos/software-project-blueprint/blob/main/CONTRIBUTING.md#roles) on engaging with the [FINOS Community](https://www.finos.org/get-involved), [FINOS Team](https://www.finos.org/team) and [FINOS Governing Board](https://www.finos.org/governing-board) to drive project success.

## About FINOS
Expand All @@ -17,18 +17,18 @@ The open source software and standards projects hosted within FINOS cover a wide

The [FINOS Landscape](https://landscape.finos.org) provides an overview of all FINOS projects and Special Interest Groups, and the [FINOS GitHub organization](https://github.com/finos) hosts the code of all FINOS projects.

# Maintainer Role
## Maintainer Role
Each FINOS project and SIG has a community of [participants](https://github.com/finos/software-project-blueprint/blob/main/CONTRIBUTING.md#roles), also referred to as "contributors", and [maintainers](https://github.com/finos/software-project-blueprint/blob/main/CONTRIBUTING.md#roles).

A **contributor** is anyone who submits a contribution to the project. Contributions include code & pull requests, issues, comments, documentation, media, or any combination of the above.

A **maintainer** is a contributor who, by virtue of their contribution history, has been given [write access](https://docs.github.com/en/organizations/managing-access-to-your-organizations-repositories/repository-roles-for-an-organization#repository-roles-for-organizations) to project repositories and may approve and merge contributions to the project.
A **maintainer** is a contributor who, by virtue of their contribution history, has been given [write access](https://docs.github.com/en/organizations/managing-access-to-your-organizations-repositories/repository-roles-for-an-organization#repository-roles-for-organizations) to project repositories and may approve and merge contributions to the project.

It is possible, and advised, that projects have multiple maintainers, in which case maintainers will elect one or two **lead maintainers**. The lead maintainer is the project's interface with the FINOS Team and Governing Board. Lead maintainers are responsible for communicating with the FINOS Team, Governing Board and Community on behalf of the project. The lead maintainer(s) are also accountable for steering project direction and prioritisation with the rest of the project community. They are also accountable for the quality of deliverables produced by the project community.

FINOS Standards projects can also have [**editors**](https://github.com/finos/standards-project-blueprint/blob/master/governance-documents/5._Governance.md#1roles).

# Maintainer responsibilities and available resources
## Maintainer responsibilities and available resources

FINOS project maintainers are responsible for technical & subject matter oversight of the project, and for driving community growth and engagement. FINOS supports project maintainers and their project communities through:
- **operational enablement & support**: GitHub, meeting infrastructure
Expand All @@ -41,8 +41,8 @@ The below table lists maintainers' responsibilities and available resources. Ple

| Maintainer Responsibility | How FINOS supports you |
|:---|:---|
| **Grow project maturity and community** | Virtually all FINOS hosted projects are expected to strive towards, and ultimately attain, [Graduated status](/docs/governance/lifecycle-stages/graduated). The FINOS team supports projects in this journey through: <ul><li> **operational enablement**: see the [LFX Project Control Center](https://docs.linuxfoundation.org/lfx/project-control-center)</li><li>**community marketing & engagement support**: Participation and/or feature your project in the [FINOS Newsletter](https://www.finos.org/newsletter), [FINOS Community Blog](https://www.finos.org/blog), [Open Source in Finance Podcast](https://podcasts.apple.com/us/podcast/finos-open-source-in-finance-podcast/id1512371068), [FINOS events](https://www.finos.org/hosted-events) including the [Open Source Strategy Forum (OSSF)](https://events.linuxfoundation.org/open-source-strategy-forum/)</li><li>[Request the creation](https://github.com/finos/community/issues/new?assignees=mcleo-d&labels=comms-channel-request&template=Communication_channel_request.md&title=) of a [FINOS Slack](https://finos-lf.slack.com/) Channel or enable GitHub Team Discussions for your FINOS Project or SIG. </li></ul> |
| **Grow project maturity and community** | Virtually all FINOS hosted projects are expected to strive towards, and ultimately attain, [Graduated status](/docs/governance/lifecycle-stages/graduated). The FINOS team supports projects in this journey through: <ul><li> **operational enablement**: see the [LFX Project Control Center](https://docs.linuxfoundation.org/lfx/project-control-center)</li><li>**community marketing & engagement support**: Participation and/or feature your project in the [FINOS Newsletter](https://www.finos.org/newsletter), [FINOS Community Blog](https://www.finos.org/blog), [Open Source in Finance Podcast](https://podcasts.apple.com/us/podcast/finos-open-source-in-finance-podcast/id1512371068), [FINOS events](https://www.finos.org/hosted-events) including the [Open Source in Finance Forum (OSFF)](https://events.linuxfoundation.org/open-source-finance-forum/)</li><li>[Request the creation](https://github.com/finos/community/issues/new?assignees=mcleo-d&labels=comms-channel-request&template=Communication_channel_request.md&title=) of a [FINOS Slack](https://finos-lf.slack.com/) Channel or enable GitHub Team Discussions for your FINOS Project or SIG. </li></ul> |
| **Run Project Meetings** | Project maintainers are welcome to engage with their project community through project meetings. If they choose to do so, maintainers are responsible for creating meeting agendas, recording meeting attendance and publishing meeting minutes. <ul><li>[Follow FINOS Meeting Procedures from the FINOS Community Governance Repository.](/docs/governance/meeting-procedures)</li><li>[Run Project Meetings from GitHub Issues using the Meeting Attendee Tracker Action.](/docs/collaboration-infrastructure#meeting-minutes)</li></ul> |
| **CI/CD** . | Project maintainers are responsible for integrating Continuous Integration and Continuous Deployment into their FINOS project builds: <ul><li>[Use the FINOS Open Developer Platform for Continuous Integration and Deployment.](/docs/development-infrastructure/continuous-integration/intro/)</li></ul> |
| **CI/CD** | Project maintainers are responsible for integrating Continuous Integration and Continuous Deployment into their FINOS project builds: <ul><li>[Use the FINOS Open Developer Platform for Continuous Integration and Deployment.](/docs/development-infrastructure/continuous-integration/intro/)</li></ul> |
| **Documentation** | Maintainers are responsible for publishing project documentation from their project's GitHub Repositories to FINOS Project Websites. <ul><li>[Use Docusaurus and GitHub Actions for Publishing Project Documentation.](/docs/development-infrastructure/project-documentation#docusaurus)</li></ul> |
| **Security** | Maintainers are responsible for preventing, discovering and responsibly disclosing Security Vulnerability Issues as they affect their projects<ul><li>[Use the FINOS Open Developer Platform for Project Security Vulnerability Scanning.](/docs/development-infrastructure/code-validation/whitesource)</li><li>[Follow the FINOS responsible disclosure policy.](/docs/governance/Software-Projects/cve-responsible-disclosure)</li></ul> |
1 change: 1 addition & 0 deletions docs/governance/Board-Election-Procedure.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
id: board-election
title: Governing Board Election Procedure
description: "How FINOS elects its Governing Board: procedures, ranked-choice voting, seat classes, and participation for Platinum, Gold, and Silver member firms."
---

FINOS uses a ranked-choice instant-runoff voting process for elections of Gold and Silver representatives on the Governing Board. These are the rules by which the results are tabulated. (Platinum representatives are not elected, but are appointed by individual Platinum members.)
Expand Down
1 change: 1 addition & 0 deletions docs/governance/Charter.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
id: funding-documents
title: FINOS Funding Documents
description: "The Linux Foundation FINOS Charter and Participation Agreement: membership, board structure, and legal terms for collaborative open source projects."
---

FINOS is a directed fund of the Linux Foundation governed by the following documents publicly available on the [FINOS website governance page](https://finos.org/governance):
Expand Down
1 change: 1 addition & 0 deletions docs/governance/Code-of-Conduct.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
id: code-of-conduct
title: Community Code of Conduct
description: "The FINOS Community Code of Conduct: expected behavior, reporting issues, and inclusive collaboration across meetings, chat, and GitHub for all participants."
---

## Overview
Expand Down
1 change: 1 addition & 0 deletions docs/governance/Collaborative-Principles.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
id: collaborative-principles
title: Our Collaborative Principles
description: "Collaborative principles for FINOS: openness, respect, transparency, and productive engagement across members, maintainers, and contributors in open finance."
---

FINOS technical projects are free to determine their own governance so long as it is consistent with [FINOS policies](https://finos.org/governance). However, projects are expected to adhere to best practices for open source collaboration. The practices documented here help to ensure that FINOS projects are well-documented, inclusive, free of intellectual property issues, and responsive to their communities.
Expand Down
1 change: 1 addition & 0 deletions docs/governance/Individual-Supporter-Program.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
id: individual-supporter-program
title: Individual Supporter Program
description: "FINOS Individual Supporter program: benefits and recognition for people who give sustained contributions to projects without a corporate membership."
---

The Individual Supporter program recognizes individuals who are not affiliated with FINOS corporate members but have made significant contributions to FINOS collaborative projects. Individuals who meet the criteria below may apply to join the program and receive members-only benefits.
Expand Down
1 change: 1 addition & 0 deletions docs/governance/Meeting-Procedures.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
id: meeting-procedures
title: Meetings of FINOS projects
description: "How FINOS projects and SIGs run meetings: agendas, minutes, the public community calendar, and tools maintainers use to keep discussions effective."
---

:::caution
Expand Down
1 change: 1 addition & 0 deletions docs/governance/Project-Branding-Guidelines.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
id: project-branding-guidelines
title: Project Branding Guidelines
description: "Project naming, logos, and trademarks for FINOS software: follow foundation branding and Linux Foundation policies so users can trust your marks."
---

One of the first steps any open source project takes is choosing a name (and possibly a logo). Project names and logos (referred to collectively as "marks" in this document) should be distinctive and should avoid incorporating the names and logos of third parties and third-party products.
Expand Down
1 change: 1 addition & 0 deletions docs/governance/Project-Lifecycle.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
id: project-lifecycle
title: Lifecycle introduction
description: "FINOS project lifecycle at a glance: how projects move from formation through graduated or archived, and what each stage means for users and members."
---

# Introduction
Expand Down
Loading
Loading