Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/finbourne/__template


https://github.com/finbourne/__template

Last synced: 22 days ago
JSON representation

Awesome Lists containing this project

README

        

![LUSID_by_Finbourne](./resources/Finbourne_Logo_Teal.svg)

# ${REPO_NAME}

## Getting Started

## Contributing

We welcome community participation in our tools. For information on contributing see our article [here](/finbourne/${REPO_NAME}/docs)

## Reporting Issues
If you encounter any issues please report these the Github [issues page](https://github.com/finbourne/${REPO_NAME}/issues).

---

# TODOs

- [ ] update repo name in template
- [ ] set up [GitHub Actions](https://docs.github.com/en/actions) automated build
- [ ] set up [SonarCloud](https://sonarcloud.io/organizations/finbourne/projects) build
- [ ] add quickstart install documentation to the README
- [ ] add setup/install documentation to the Wiki

## Update repo name

Update the `${REPO_NAME}` to the repo name in the following:
* `README.md`
* `.github/bug_report.md`

## Add badges
* version
* build status
* GitHub Actions
* SonarCloud build

e.g.

![PyPI](https://img.shields.io/pypi/v/lusidtools?color=blue)
[![Build Status](https://travis-ci.org/finbourne/lusid-python-tools.svg?branch=master)](https://travis-ci.org/finbourne/lusid-python-tools)
![](https://github.com/finbourne/lusid-python-tools/workflows/commit-hook/badge.svg)
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=finbourne_lusid-python-tools&metric=alert_status)](https://sonarcloud.io/dashboard?id=finbourne_lusid-python-tools)

```
![PyPI](https://img.shields.io/pypi/v/lusidtools?color=blue)
[![Build Status](https://travis-ci.org/finbourne/lusid-python-tools.svg?branch=master)](https://travis-ci.org/finbourne/lusid-python-tools)
![](https://github.com/finbourne/lusid-python-tools/workflows/commit-hook/badge.svg)
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=finbourne_lusid-python-tools&metric=alert_status)](https://sonarcloud.io/dashboard?id=finbourne_lusid-python-tools)
```