Skip to content
This repository has been archived by the owner on Oct 28, 2022. It is now read-only.
/ wimpo Public archive

WIM Repository Template: example README and other boilerplate files

License

Notifications You must be signed in to change notification settings

USGS-WiM/wimpo

Repository files navigation

Archive

New repositories should be created in GitLab (code.usgs.gov). Please refer to https://code.usgs.gov/WiM/wimpo instead of this repo.

This is a template repository for new WIM repositories. It contains the required repository files (explanation here) and starter README text (below). (Delete this sentence when editing README)

WiM

Project Title

One Paragraph of project description goes here

Prerequisites

Prerequisities needed to install the software and how to install them

Installing

Provide the steps needed to install and run. Provide actual commands when possible.

First step

install app

Second step

other command

...etc

Building and testing

If applicable, explain how to build and test the application.

Development Workflow

Explain the desired workflow for development. This should be outlined by the lead developer of the repository, based on the guidelines and requirements detailed in the WIM Collaborative Development Constitution.

Deployment

Add additional notes about how to deploy this on a live system. Do not include any credentials, IP addresses, or other sensitive information.

Built With

This where you list the main dependencies/software packages used. Include a link and a short description of how it is used in your project. Below are just some examples.

  • Angular - The main web framework used
  • NPM - Dependency Management
  • Others - Any other high-level dependencies

Contributing

Please read CONTRIBUTING.md for details on the process for submitting pull requests to us. Please read CODE_OF_CONDUCT.md for details on adhering by the USGS Code of Scientific Conduct.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Advance the version when adding features, fixing bugs or making minor enhancement. Follow semver principles. To add tag in git, type git tag v{major}.{minor}.{patch}. Example: git tag v2.0.5

To push tags to remote origin: git push origin --tags

When a new release (or version) occurs, change the Unreleased section of the CHANGELOG.md into a new release version section and start a clean Unreleased section.

*Note that your alias for the remote origin may differ.

Authors

See also the list of contributors who participated in this project.

License

This project is licensed under the Creative Commons CC0 1.0 Universal License - see the LICENSE.md file for details.

Suggested Citation

In the spirit of open source, please cite any re-use of the source code stored in this repository. Below is the suggested citation:

This project contains code produced by the Web Informatics and Mapping (WIM) team at the United States Geological Survey (USGS). As a work of the United States Government, this project is in the public domain within the United States. https://wim.usgs.gov

Scientific Citations

This project implements methodology or uses data from the following reports and data releases. See the Scientific_Documentation.md file for details.

Doe, J.E., Smith, A.B., and Doe, J.M., 2022, Title of the report: U.S. Geological Survey Scientific Investigations Report XXXX–XXXX, XX p., https://doi.org/XX.XXXX/sirXXXXXXXX.

Doe, J.E., Smith, A.B., and Doe, J.M., 2022, Data release for described data: U.S. Geological Survey data release, https://doi.org/XX.XXXX/XXXXXXXX.

Acknowledgments

  • Hat tip to anyone who's code was used
  • Inspiration Note

About WIM

  • This project authored by the USGS WIM team
  • WIM is a team of developers and technologists who build and manage tools, software, web services, and databases to support USGS science and other federal government cooperators.
  • WIM is a part of the Upper Midwest Water Science Center.