generated from finos/software-project-blueprint
-
Notifications
You must be signed in to change notification settings - Fork 139
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
54 changed files
with
67 additions
and
1,191 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,3 @@ | ||
# Code of Conduct for {project name} | ||
# Code of Conduct for Legend | ||
|
||
Please see the [Community Code of Conduct](https://www.finos.org/code-of-conduct). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
# Contributing to {project name} | ||
# Contributing to Legend | ||
|
||
## Contributor License Agreement (CLA) | ||
A CLA is a document that specifies how a project is allowed to use your | ||
|
@@ -10,22 +10,22 @@ must be made with a | |
in place, and there are [additional legal requirements](https://finosfoundation.atlassian.net/wiki/spaces/FINOS/pages/75530375/Legal+Requirements) | ||
that must also be met.** | ||
|
||
Commits and pull requests to FINOS repositories such as {project name} will only be accepted from those contributors with an active, executed Individual Contributor License Agreement (ICLA) with FINOS OR who are covered under an existing and active Corporate Contribution License Agreement (CCLA) executed with FINOS. Commits from individuals not covered under an ICLA or CCLA will be flagged and blocked by the FINOS ["CLA Bot" tool](https://github.com/finos/cla-bot). Please note that some CCLAs require individuals/employees to be explicitly named on the CCLA. | ||
Commits and pull requests to FINOS repositories such as legend-pure will only be accepted from those contributors with an active, executed Individual Contributor License Agreement (ICLA) with FINOS OR who are covered under an existing and active Corporate Contribution License Agreement (CCLA) executed with FINOS. Commits from individuals not covered under an ICLA or CCLA will be flagged and blocked by the FINOS ["CLA Bot" tool](https://github.com/finos/cla-bot). Please note that some CCLAs require individuals/employees to be explicitly named on the CCLA. | ||
|
||
As a result, PRs submitted to the {project name} project cannot be accepted until you have a CLA in place with the Foundation. | ||
As a result, PRs submitted to the Legend project cannot be accepted until you have a CLA in place with the Foundation. | ||
|
||
Need an ICLA? Unsure if you are covered under an existing CCLA? Email [[email protected]](mailto:[email protected]?subject=CLA) | ||
|
||
## Contributing Issues | ||
|
||
### Prerequisites | ||
|
||
* [ ] Have you [searched for duplicates](https://github.com/finos/{project name}/issues?utf8=%E2%9C%93&q=)? A simple search for exception error messages or a summary of the unexpected behaviour should suffice. | ||
* [ ] Have you [searched for duplicates](https://github.com/finos/legend-pure/issues?utf8=%E2%9C%93&q=)? A simple search for exception error messages or a summary of the unexpected behaviour should suffice. | ||
* [ ] Are you running the latest version? | ||
* [ ] Are you sure this is a bug or missing capability? | ||
|
||
### Raising an Issue | ||
* Create your issue [here](https://github.com/finos/{project name}/issues/new). | ||
* Create your issue [here](https://github.com/finos/legend-pure/issues/new). | ||
* New issues contain two templates in the description: bug report and enhancement request. Please pick the most appropriate for your issue, **then delete the other**. | ||
* Please also tag the new issue with either "Bug" or "Enhancement". | ||
* Please use [Markdown formatting](https://help.github.com/categories/writing-on-github/) | ||
|
@@ -37,12 +37,12 @@ To make review of PRs easier, please: | |
|
||
* Please make sure your PRs will merge cleanly - PRs that don't are unlikely to be accepted. | ||
* For code contributions, follow the existing code layout. | ||
* For documentation contributions, follow the general structure, language, and tone of the [existing docs](https://github.com/finos/{project name}/wiki). | ||
* For documentation contributions, follow the general structure, language, and tone of the [existing docs](https://github.com/finos/legend-pure/wiki). | ||
* Keep commits small and cohesive - if you have multiple contributions, please submit them as independent commits (and ideally as independent PRs too). | ||
* Reference issue #s if your PR has anything to do with an issue (even if it doesn't address it). | ||
* Minimise non-functional changes (e.g. whitespace). | ||
* Ensure all new files include a header comment block containing the [Apache License v2.0 and your copyright information](http://www.apache.org/licenses/LICENSE-2.0#apply). | ||
* If necessary (e.g. due to 3rd party dependency licensing requirements), update the [NOTICE file](https://github.com/finos/{project name}/blob/master/NOTICE) with any new attribution or other notices | ||
* If necessary (e.g. due to 3rd party dependency licensing requirements), update the [NOTICE file](https://github.com/finos/legend-pure/blob/master/NOTICE) with any new attribution or other notices | ||
|
||
|
||
### Commit and PR Messages | ||
|
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,7 @@ | ||
SPDXVersion: SPDX-2.0 | ||
DataLicense: CC0-1.0 | ||
Creator: {name of copyright owner} | ||
PackageName: {project name} | ||
PackageOriginator: {name of copyright owner} | ||
PackageHomePage: https://github.com/finos/{project name} | ||
Creator: Goldman Sachs | ||
PackageName: Legend | ||
PackageOriginator: Goldman Sachs | ||
PackageHomePage: https://github.com/finos/legend-pure | ||
PackageLicenseDeclared: Apache-2.0 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,4 @@ | ||
{project name} - FINOS | ||
Copyright {yyyy} - {current_year} {name of copyright owner} {email of copyright holder} | ||
Legend - FINOS | ||
Copyright 2020 Goldman Sachs - [email protected] | ||
|
||
This product includes software developed at the Fintech Open Source Foundation (https://www.finos.org/). | ||
|
||
{Other notices, as necessary} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,33 +1,64 @@ | ||
<img align="right" width="40%" src="https://www.finos.org/hubfs/FINOS/finos-logo/FINOS_Icon_Wordmark_Name_RGB_horizontal.png"> | ||
[](https://finosfoundation.atlassian.net/wiki/display/FINOS/Incubating) | ||
 | ||
|
||
# project-blueprint | ||
# legend-pure | ||
|
||
Project blueprint is a GitHub repository template for all [Fintech Open Source Foundation (FINOS)](https://www.finos.org/) hosted GitHub repositories, contributed and maintained by FINOS as part of the [Open Developer Platform (ODP)](https://odp.finos.org) initiative. | ||
Short blurb about what your project does. | ||
|
||
## How to use this blueprint | ||
## Installation | ||
|
||
1. Read the docs on [ODP website](https://odp.finos.org/docs/project-collaboration#finos-project-blueprint) | ||
2. Clone this repository locally (`git clone https://github.com/finos/project-blueprint.git`) | ||
3. 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). | ||
4. Copy the `README.template.md` file to your repository, and rename it to `README.md`. | ||
5. Search and replace the following tokens in the newly copied files: | ||
OS X & Linux: | ||
|
||
| 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). | | ||
```sh | ||
npm install my-crazy-module --save | ||
``` | ||
|
||
Windows: | ||
|
||
```sh | ||
edit autoexec.bat | ||
``` | ||
|
||
## Usage example | ||
|
||
A few motivating and useful examples of how your project can be used. Spice this up with code blocks and potentially screenshots / videos ([LiceCap](https://www.cockos.com/licecap/) is great for this kind of thing). | ||
|
||
_For more examples and usage, please refer to the [Wiki][wiki]._ | ||
|
||
## Development setup | ||
|
||
Describe how to install all development dependencies and how to run an automated test-suite of some kind. Potentially do this for multiple platforms. | ||
|
||
```sh | ||
make install | ||
npm test | ||
``` | ||
|
||
## Roadmap | ||
|
||
List the roadmap steps; alternatively link the Confluence Wiki page where the project roadmap is published. | ||
|
||
1. Item 1 | ||
2. Item 2 | ||
3. .... | ||
|
||
## Contributing | ||
|
||
1. Fork it (<https://github.com/finos/legend-pure/fork>) | ||
2. Create your feature branch (`git checkout -b feature/fooBar`) | ||
3. Read our [contribution guidelines](.github/CONTRIBUTING.md) and [Community Code of Conduct](https://www.finos.org/code-of-conduct) | ||
4. Commit your changes (`git commit -am 'Add some fooBar'`) | ||
5. Push to the branch (`git push origin feature/fooBar`) | ||
6. Create a new Pull Request | ||
|
||
_NOTE:_ Commits and pull requests to FINOS repositories will only be accepted from those contributors with an active, executed Individual Contributor License Agreement (ICLA) with FINOS OR who are covered under an existing and active Corporate Contribution License Agreement (CCLA) executed with FINOS. Commits from individuals not covered under an ICLA or CCLA will be flagged and blocked by the FINOS Clabot tool. Please note that some CCLAs require individuals/employees to be explicitly named on the CCLA. | ||
|
||
*Need an ICLA? Unsure if you are covered under an existing CCLA? Email [[email protected]](mailto:[email protected])* | ||
|
||
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](https://finosfoundation.atlassian.net/wiki/spaces/FINOS/pages/75530255/License+Categories). | ||
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](https://www.apache.org/licenses/LICENSE-2.0.html#apply). | ||
8. Commit all of your changes. | ||
|
||
## License | ||
|
||
Copyright 2019 Fintech Open Source Foundation | ||
Copyright 2020 Goldman Sachs | ||
|
||
Distributed under the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0). | ||
|
||
|
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.