Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
49 lines (33 loc) · 2.36 KB

CONTRIBUTING.md

File metadata and controls

49 lines (33 loc) · 2.36 KB

Welcome!

We're so glad you're thinking about contributing to a open source project of the U.S. government! We encourage you to read the CONTRIBUTING policy (you are here), its LICENSE, and its README.

Policies

We want to ensure a welcoming environment for all of our projects. Our staff follow the TTS Code of Conduct and all contributors should do the same.

Publishing workflow

This describes the workflow for how edits are incorporated and published to the site.

  1. All changes are submitted through pull requests. Site owners should use branches while members of the public should use forks.
  2. Each site owner must approve a pull request before it can be merged.
  3. Changes are merged to the main branch where they are automatically published to resources.data.gov and the publishing is done.

DCAT-US 3.0 documentation workflow

This repository includes a git submodule at _external/dcat-us for upstream DCAT-US 3.0 documentation. The local checkout is configured as sparse checkout to only include:

  • jsonschema/definitions/
  • jsonschema/docs/

Builds merge those upstream markdown files into local pages using:

  • npm run merge-dcat-us-docs

To update upstream content:

  1. Run git submodule update --remote _external/dcat-us.
  2. Re-apply sparse checkout patterns:
    • git -C _external/dcat-us sparse-checkout init --no-cone
    • printf "/jsonschema/definitions/\n/jsonschema/docs/\n" | git -C _external/dcat-us sparse-checkout set --stdin
  3. Run npm run merge-dcat-us-docs.
  4. Review generated pages under pages/_data_standards/dcat-us-3/ and commit.

Public domain

This project is in the public domain within the United States, and copyright and related rights in the work worldwide are waived through the CC0 1.0 Universal public domain dedication.

All contributions to this project will be released under the CC0 dedication. By submitting a pull request or issue, you are agreeing to comply with this waiver of copyright interest.