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. 

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

3. 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.

4. Create a pull request (PR) from your branch to the master branch in USNISTGOV/PrivacyEngCollabSpace. 

5. 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.