Skip to content

Latest commit

 

History

History
66 lines (42 loc) · 2.54 KB

README.template.md

File metadata and controls

66 lines (42 loc) · 2.54 KB
Raw

FINOS - Incubating

{project name}

Short blurb about what your project does.

Installation

OS X & Linux:

npm install my-crazy-module --save

Windows:

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 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.

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

For any questions, bugs or feature requests please open an [issue](https://github.com/finos/{project slug}/issues) For anything else please send an email to {project mailing list}.

To submit a contribution:

  1. Fork it (<https://github.com/finos/{project slug}/fork>)
  2. Create your feature branch (git checkout -b feature/fooBar)
  3. Read our contribution guidelines and Community 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 (or EasyCLA). 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 help@finos.org

License

Copyright {yyyy} {name of copyright owner}

Distributed under the Apache License, Version 2.0.

SPDX-License-Identifier: Apache-2.0