Skip to main content
U.S. flag

An official website of the United States government

Dot gov

The .gov means it’s official.
Federal government websites often end in .gov or .mil. Before sharing sensitive information, make sure you’re on a federal government site.

Https

The site is secure.
The https:// ensures that you are connecting to the official website and that any information you provide is encrypted and transmitted securely.

Contribution Instructions

Tools and use cases are contributed via GitHub pull requests, while feedback is contributed via GitHub issues. Contributed tools and use cases can be hosted directly in the NIST repository, or you can host them elsewhere online and link to them from the NIST repository.

How to Contribute Tools and Use Cases 

  1. Fork a copy of USNISTGOV/PrivacyEngCollabSpace to your own organizational or personal space. 

  1. Create a branch in your fork, named specifically for your contribution. 

  1. In your branch: 


    A. Create a new directory within the relevant tool or use case directory: tools/de-identification, tools/risk-assessment, use-cases/de-identification, or use-cases/risk-assessment.
    Example: tools/de-identification/[your-contribution-name] 

    B. Name the directory to describe your contribution. 

    C. Include in the directory a README.md file that follows the relevant template. There is a template for a tool and for a use case contribution.

    D. If hosting a tool in this repository, also include in the directory any pertinent source code files or documentation.

    E. Update the README.md file of the main directory to which you’re contributing. This README provides an index of that directory's contents. It should include an entry reflecting your contribution.
    1. Create a pull request (PR) from your branch to the master branch in USNISTGOV/PrivacyEngCollabSpace. 

    2. Moderators will then review the PR and may provide comments and suggestions to the contributor. 

    How to Contribute Feedback 

    Submit an issue to provide feedback on tools or use cases in the space. Please select appropriate tags related to the feedback.

    Contribute

    Create a pull request or submit an issue on GitHub.

    Contribute on GitHub

    GitHub Help

    If you're having trouble with these instructions, and need more information about GitHub, pull requests, and issues, visit GitHub's Help page.

    GitHub Help

    Contribution Assistance

    If you're having trouble submitting your contribution to this space, or otherwise would like to send us feedback, contact us.

    collabspace [at] nist.gov (Contact Us)

    Created November 21, 2018, Updated March 28, 2019