project-blueprint

Project blueprint for new Fintech Open Source Foundation (FINOS) hosted GitHub repositories.

How to use this blueprint

1. Clone this repository locally (git clone https://github.com/finos/project-blueprint.git)
2. Copy the LICENSE, LICENSE.spdx, and NOTICE files, as well as the entire .github directory, to your own repository (do not copy this README.md file).
3. Copy the README.template.md file to your repository, and rename it to README.md.
4. Search and replace the following tokens in the newly copied files:

Token	Replace with
{program name}	The name of the GitHub organization the project resides in.
{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).

5. Open the NOTICE file in a text editor and either remove the {Other notices, as necessary} token, or add attributions if required by your code's dependencies.
6. Open the README.md file in a text editor and complete the content as appropriate for your project.
7. Add the Apache license header to all of your source files.
8. Commit all of your changes.

License

Copyright 2019 Fintech Open Source Foundation

Distributed under the Apache License, Version 2.0.

SPDX-License-Identifier: Apache-2.0