Project blueprint is a GitHub repository template for all Fintech Open Source Foundation (FINOS) hosted GitHub repositories, contributed and maintained by FINOS.
Please also follow the instructions on community.finos.org/docs/collaboration-infrastructure#finos-project-blueprint.
- Click Use this template on this repository and follow GitHub's instructions.
- In your new repository, copy
README.template.mdtoREADME.md(replacing this file). - Search and replace the following tokens across the copied files:
| 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_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 |
- Open the
NOTICEfile and either remove{OTHER_NOTICES}or add attributions if required by your code's dependencies. - Open
README.mdand complete the content as appropriate for your project. - Open
MAINTAINERS.mdand add maintainer names, GitHub usernames, and email addresses. - (Optional) Remove the
docs/andwebsite/folders if you do not need a project documentation website.
Placeholders use {UPPER_SNAKE_CASE} tokens throughout the blueprint.
A preview of the blueprint can be found on project-blueprint.finos.org
This blueprint implements FINOS open source software project governance on community.finos.org.
Copyright 2019 Fintech Open Source Foundation
Distributed under the Apache License, Version 2.0.
SPDX-License-Identifier: Apache-2.0