Skip to content

Latest commit

 

History

History
128 lines (86 loc) · 4.97 KB

CONTRIBUTING.md

File metadata and controls

128 lines (86 loc) · 4.97 KB

How to Contribute

We're so thankful you're considering contributing to an open source project of the U.S. government! If you're unsure about anything, just ask -- or submit the issue or pull request anyway. The worst that can happen is you'll be politely asked to change something. We appreciate all friendly contributions.

We encourage you to read this project's CONTRIBUTING policy (you are here), its LICENSE, and its README.

Getting Started

Building Dependencies

First, install the dependencies that are required for these scripts:

Building the Project

For instructions on how to invoke the script, see the usage section of the README

Workflow and Branching

We follow the GitHub Flow Workflow

  1. Fork the project
  2. Check out the main branch
  3. Create a feature branch
  4. Write code and tests for your change
  5. From your branch, make a pull request against DSACMS/repodive-tools/main
  6. Work with repo maintainers to get your change reviewed
  7. Wait for your change to be pulled into DSACMS/repodive-tools/main
  8. Delete your feature branch

Issues

  1. Check for Existing Issues
    • Before opening a new issue, please check if a similar issue already exists. You can search through the existing issues to avoid duplicates.
  2. Choose the Correct Issue Type
    • Bug Report: For reporting bugs or unexpected behavior in the application.
    • Feature Request: To suggest new features or enhancements.
    • Question/Help: If you need help understanding a feature or resolving a problem.
  3. Provide Clear Details:
    • Summary: A clear and concise title.
    • Description: Explain the problem or feature in detail, including any relevant context.
    • Steps to Reproduce: If you're reporting a bug, describe the steps someone can follow to reproduce the problem.
    • Expected Behavior: What did you expect to happen?
    • Actual Behavior: What actually happened?
    • Screenshots or Logs: Include any logs, error messages, or screenshots that can help diagnose the issue.
    • Environment: Mention the environment where the issue occurred (OS, Python version, dependencies).
  4. Labels and Templates
    • If available, select the appropriate labels (e.g., bug, enhancement, help wanted).

Policies

Open Source Policy

We adhere to the CMS Open Source Policy. If you have any questions, just shoot us an email.

Security and Responsible Disclosure Policy

Submit a vulnerability: Vulnerability reports can be submitted through Bugcrowd. Reports may be submitted anonymously. If you share contact information, we will acknowledge receipt of your report within 3 business days.

For more information about our Security, Vulnerability, and Responsible Disclosure Policies, see SECURITY.md.

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 as indicated in LICENSE.

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.