finos / software-project-blueprint

Project blueprint for Fintech Open Source Foundation hosted projects.

FINOS Software Project Blueprint

Project blueprint is a GitHub repository template for all Fintech Open Source Foundation (FINOS) hosted GitHub repositories, contributed and maintained by FINOS.

How to use this blueprint

Please follow instructions on community.finos.org/docs/collaboration-infrastructure#finos-project-blueprint

Blueprint preview

A preview of the blueprint can be found on project-blueprint.finos.org

Governance

This blueprint implements https://community.finos.org/docs/governance/#open-source-software-projects

License

Copyright 2019 Fintech Open Source Foundation

Distributed under the Apache License, Version 2.0.

SPDX-License-Identifier: Apache-2.0

software-project-blueprint's Issues

Governance link broken

Bug Report - Governance link broken

Steps to Reproduce:

1. Click the link associated with "blueprint implements" https://github.com/finos/community/tree/master/governance#open-source-software-projects

Expected Result:

That I would see the project governance.

Actual Result:

Pulled a 404.

Add placeholder for {project slug}

Currently, there's only a {project name} placeholder, used for name and slug; this causes a lot of re-work when using the project blueprint. Please add and document (on https://odp.finos.org/docs/project-collaboration/#finos-project-blueprint ) a new placeholder called {project slug}

Project blueprint should have the new governance built in

• Check if CONTRIBUTING.md works on root folder
• Merge CONTRIBUTING.template.md into CONTRIBUTING.md
• Update title to Software Project Blueprint
• "This blueprint implements https://github.com/finos/community/tree/master/governance#open-source-software-projects" into the README.md of this repo
• Arrange placeholders
• The new governance allows for a governance for software projects (https://github.com/finos/community/blob/master/governance/Software-Projects/CONTRIBUTING.template.md) and one for standard projects (https://github.com/finos/community/blob/master/governance/Standards-Projects/CONTRIBUTING.standards.md).

For now, I suggest you have both of them in the blueprint and then remember to select the correct one when you instantiate a new project.

Once you are done can you also send a pull request to Morphir and Glue to adopt it (apologizing it wasn't done in the first place)?

Deprecate CONTRIBUTING.md for new CONTRIBUTING.template.md and CONTRIBUTING.standards.md

• Shall https://github.com/finos/project-blueprint/blob/master/CONTRIBUTING.md be deprecated in favour of https://github.com/finos/project-blueprint/blob/master/CONTRIBUTING.standards.md and https://github.com/finos/project-blueprint/blob/master/CONTRIBUTING.template.md ?
• Update any Wiki/microsite/issue-template that points to the old CONTRIBUTING.md file

Enable Netlify on software-project-blueprint repository

Description

Netlify should be integrated into the software-project-blueprint repository to enable Docusaurus builds and previewing upon pull request. The following tasks should be followed.

Tasks

• Remove GitHub Action https://github.com/finos/software-project-blueprint/blob/main/.github/workflows/docusaurus.yml
• Enable Netlify on software-project-blueprint
• Test against pull request #26

Files in /docs are empty

Please add some blueprint content into https://github.com/finos/software-project-blueprint/tree/main/docs

Take basic content from odp.finos.org

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• Update docusaurus monorepo to v3.3.2 (@docusaurus/core, @docusaurus/preset-classic)
• Update dependency eslint to v9

Detected dependencies

nodenv

.node-version

• node 20.13.1

npm

website/package.json

• @docusaurus/core ^3.1.0
• @docusaurus/preset-classic ^3.1.0
• classnames ^2.5.1
• clsx ^2.0.0
• prism-react-renderer ^2.3.0
• react ^18.0.0
• react-dom ^18.0.0
• eslint ^8.0.0
• eslint-plugin-react ^7.23.2
• node >=18.0

---

• Check this box to trigger a request for Renovate to run again on this repository

Standardizing microsite footers

From finos/community#184

Right now each microsite (like https://osr.finos.org/) has a different footer (footer.js) content.

ODP:

FINOS Projects
FINOS Landscape
FINOS Projects on GitHub
Collaboration Infrastructure
FINOS Governance
Community Governance
FINOS Charter
Meeting Procedures
About FINOS
FINOS Website
Engage the FINOS Community
FINOS News and Events

OSR:

Docs
Team
Roadmap
FINOS
FINOS Website
Community Handbook
Community Governance
More
Follow @FinosFoundation
FINOS on LinkedIn

My suggestion would be to have a standardized footer as part of one of the main finos repos, in a separate branch, with the ability to git submodule that footer.js file into the individual repos containing the microsites.

update links in Docusaurus template

In https://github.com/finos/software-project-blueprint/blob/main/website/docusaurus.config.js there are links to finosfoundation.atlassian.net which need to be updated to community.finos.org (please find the right sub page that reflects best the title of the link.

Should I copy the whitesource configuration to my project?

Support Question

Thank you very much for the effort put in this blueprint! It helps tremendously with the new setup. Something which is left unclear (to me at least) is the usage of the whitesource configuration files. They are present in the repo, but not mentioned in the README. What would be the recommended way to use them?

Thanks!

Embed CONTRIBUTING.md into Docusaurus microsite

Feature Request

Description of Problem:

The CONTRIBUTING.md file is part of the project blueprint and includes important info regarding new contributors onboarding, which are also part of the Docusaurus microsite.

Proposed solution:

Enhance the Docusaurus build process to create a new Docusaurus page with the CONTRIBUTING.md content and map it to a default site URL, ie /contribute.