Skip to content

Latest commit

Β 

History

History
33 lines (22 loc) Β· 2.05 KB

CONTRIBUTING.md

File metadata and controls

33 lines (22 loc) Β· 2.05 KB

Contributors

This page is intended to provide guidance on how to format a contribution to the repository. If this is your first time contributing to the repo, we would prefer single contributions per pull request. If there is a collection of resources you wish to contribute, please file an issue before submitting a pull request.

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Contribution Flowchart

Contribution Flowchart

Contribution Format

Below is the desired contribution format to APA's Technology Divisions technology & data resources repository.

Type

A a high-level category to classify the resource into related groups. Census data could be considered "Demographic" for example.

  • Resource Name - Description of resource. Additional Information:License:Geographic Coverage:Provider:Link1:Link2.

Legend

  • Resource Name[Required]: Name of the resoure with hyperlink to main page.
  • Description of resource[Required]: A description of what it provides to viewers in a sentence or two.
  • License [Optional]: The type of open source license applied to the resource if any. More important for restricted licenses. Non-opensource resources should be labled "Proprietary" or "Other".
  • Geographic Coverage [Optional]: The reach and range of the resource in terms of Nations, States, or other recognizable geographic boundaries.
  • Provider[Optional]: Who is the sponsor or provider of the resource.
  • Additional Links[Optional]: Additional Hyper-Link(s) to the resource.

GitHub For Planners

If you are not familar with Git or GitHub, we highly recommend this webcast that accompanies this repo. This will cover the basics and discuss how to contribute to or build your own repositories.

IMAGE ALT TEXT HERE