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 also follow the instructions on community.finos.org/docs/collaboration-infrastructure#finos-project-blueprint.

1. Click Use this template on this repository and follow GitHub's instructions.
2. In your new repository, copy README.template.md to README.md (replacing this file). The lifecycle badge defaults to Incubating. Change it to the project's stage before publishing the README. The comment in README.template.md lists the other badge images.
3. Search and replace the tokens below. The same tokens are the values in website/docusaurus.config.js (except the site URL), and they appear in docs/, CONTRIBUTING.md, SECURITY.md, NOTICE, LICENSE.spdx, .github/CODE_OF_CONDUCT.md, and EASYCLA_CHANGEME.md.

Token	Replace with
{PROJECT_NAME}	The name of the FINOS project, e.g. Open Developer Platform
{PROJECT_SLUG}	The GitHub repository name, e.g. software-project-blueprint
{PROJECT_URL}	The GitHub repository URL, e.g. https://github.com/finos/software-project-blueprint
{PROJECT_SITE_URL}	The public documentation site, e.g. https://project-blueprint.finos.org
{PROJECT_MAILING_LIST}	The project mailing list address, if any
{YYYY}	The year you started working on the code
{CURRENT_YEAR}	The current year
{NAME_OF_COPYRIGHT_OWNER}	The copyright owner of the code (typically you or your employer)
{EMAIL_OF_COPYRIGHT_OWNER}	The email address of the copyright owner of the code (if known)
{OTHER_NOTICES}	Additional NOTICE attributions required by dependencies, or remove this token

4. In website/docusaurus.config.js, replace the projectSiteUrl value with the project's public site URL ({PROJECT_SITE_URL}). It has to stay a real https:// URL. This blueprint uses https://project-blueprint.finos.org so the preview site can build.
5. Docusaurus compiles doc pages as MDX, including .md files. In the page body the token is written {"{PROJECT_NAME}"} so the site builds before you replace it. Searching for {PROJECT_NAME} still updates those sentences. Front matter, including title and description, can use {PROJECT_NAME} directly. Keep a description in the front matter so Docusaurus does not copy the MDX expression into the HTML meta description.
6. Replace technical-charter.pdf with the project's executed Technical Charter. CONTRIBUTING.md treats that PDF as the charter and does not repeat it.
7. Open the NOTICE file and either remove {OTHER_NOTICES} or add attributions if required by your code's dependencies.
8. Open README.md and complete the content as appropriate for your project.
9. Open MAINTAINERS.md and add maintainer names, GitHub usernames, and email addresses.
10. Delete EASYCLA_CHANGEME.md once EasyCLA is confirmed for the project. It only exists so contributors can open a pull request that the EasyCLA bot will comment on.
11. (Optional) Remove the docs/ and website/ folders if you do not need a project documentation website. The site is built with npm. See website/README.md and netlify.toml.

Placeholders use {UPPER_SNAKE_CASE} tokens throughout the blueprint.

Blueprint preview

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

Governance

This blueprint implements FINOS open source software project governance on community.finos.org.

License

Copyright 2019 Fintech Open Source Foundation

Distributed under the Apache License, Version 2.0.

SPDX-License-Identifier: Apache-2.0