https://github.com/throughput-ec/template

A template for new repositories in the Throughput Project.
https://github.com/throughput-ec/template

earthcube nsf readme-template

Last synced: 3 months ago
JSON representation

A template for new repositories in the Throughput Project.

• Host: GitHub
• URL: https://github.com/throughput-ec/template
• Owner: throughput-ec
• License: mit
• Created: 2019-07-29T14:59:03.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2021-02-17T19:56:15.000Z (over 5 years ago)
• Last Synced: 2023-03-30T09:58:24.949Z (over 3 years ago)
• Topics: earthcube, nsf, readme-template
• Size: 95.7 KB
• Stars: 3
• Watchers: 6
• Forks: 10
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
[![lifecycle](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://www.tidyverse.org/lifecycle/#experimental)

[![NSF-XXXXXXX](https://img.shields.io/badge/NSF-XXXXXXX-blue.svg)](https://nsf.gov/awardsearch/showAward?AWD_ID=XXXXXXX) [![NSF-XXXXXXX](https://img.shields.io/badge/NSF-XXXXXXX-blue.svg)](https://nsf.gov/awardsearch/showAward?AWD_ID=XXXXXXX)

# Project Name

A short, one paragraph description of the project goes here.

  * Please add all project Award numbers to the Badges above.  This will allow us to crawl and add these repositories to the graph, and also show NSF that we are being good citizens.

  * Please ensure that all contributors from Throughput have ORCIDs and that these are linked below in the contributors section.

  * Please consider a clear directory structure early on, and report it below in the "How to use this repository".

  * Please define which data products

## Contributors

This project is an open project, and contributions are welcome from any individual.  All contributors to this project are bound by a [code of conduct](CODE_OF_CONDUCT.md).  Please review and follow this code of conduct as part of your contribution.

  * [Contributor Name1](http://example.com/contributor_url1) [![orcid](https://img.shields.io/badge/orcid-XXXX--XXXX--XXXX--XXXX-brightgreen.svg)](https://orcid.org/XXXX-XXXX-XXXX-XXXX)

  * [Contributor Name2](http://example.com/contributor_url2) [![orcid](https://img.shields.io/badge/orcid-XXXX--XXXX--XXXX--XXXX-brightgreen.svg)](https://orcid.org/XXXX-XXXX-XXXX-XXXX)

### Tips for Contributing

Issues and bug reports are always welcome.  Code clean-up, and feature additions can be done either through pull requests to [project forks]() or branches.

All products of the Throughput Annotation Project are licensed under an [MIT License](LICENSE) unless otherwise noted.

## How to use this repository

A description of the files and directory structure in the repository.

### Workflow Overview

Th project uses X core information, manages it and passes our some stuff.

### System Requirements

This project is developed using (Python? R?).  It runs on a Windows system (?).  Continuous integration uses TravisCI (?).

### Data Requirements

The project pulls data from (?).

### Key Outputs

This project generates (an API, some log files, what?)

## Metrics

This project is to be evaluated using the following metrics. . .