Project blueprint is a GitHub repository template for all Fintech Open Source Foundation (FINOS) hosted GitHub repositories, contributed and maintained by FINOS as part of the Open Developer Platform (ODP) initiative.
All commits must be signed with a DCO signature to avoid being flagged by the DCO Bot. This means that your commit log message must contain a line that looks like the following one, with your actual name and email address:
Signed-off-by: John Doe <john.doe@example.com>
Adding the -s flag to your git commit will add that line automatically. You can also add it manually as part of your commit log message or add it afterwards with git commit --amend -s.
- Clone this repository locally (
git clone https://github.com/finos-labs/project-blueprint.git) - Copy the
LICENSE,LICENSE.spdx, andNOTICEfiles, as well as the entire.githubdirectory, to your own repository (do not copy thisREADME.mdfile). - Copy the
README.template.mdfile to your repository, and rename it toREADME.md. - Search and replace the following tokens in the newly copied files:
| Token | Replace with |
|---|---|
{project name} |
The name of the GitHub repository the project resides in. |
{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). |
- Open the
NOTICEfile in a text editor and either remove the{Other notices, as necessary}token, or add attributions if required by your code's dependencies. - Open the
README.mdfile in a text editor and complete the content as appropriate for your project. - Add the Apache license header to all of your source files.
- Commit all of your changes.
Copyright 2020 Fintech Open Source Foundation
Distributed under the Apache License, Version 2.0.
SPDX-License-Identifier: Apache-2.0