Skip to content

Latest commit

 

History

History
139 lines (88 loc) · 4.85 KB

CONTRIBUTING.md

File metadata and controls

139 lines (88 loc) · 4.85 KB
Raw

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

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 cmsgov/cmsgov-example-repo/main
  6. Work with repo maintainers to get your change reviewed
  7. Wait for your change to be pulled into cmsgov/cmsgov-example-repo/main
  8. Delete your feature branch

Issues

When creating an issue please try to adhere to the following format:

### Expected behavior

As concisely as possible, describe the expected behavior.

### Actual behavior

As concisely as possible, describe the observed behavior.

### Steps to reproduce the behavior

List all relevant steps to reproduce the observed behavior.

see our .github/ISSUE_TEMPLATE.md for more examples.

Pull Requests

Comments should be formatted to a width no greater than 80 columns.

Files should be exempt of trailing spaces.

Reviewing Pull Requests

When you submit a pull request on GitHub, it will be reviewed by the project community, and once the changes are approved, your commits will be brought into a development branch for additional testing. Once the changes are merged, they will be pushed back to the main branch.

If the issue the pull request is addressing is particularly urgent, the pull request will be merged directly into the main branch.

Documentation

We also welcome improvements to the project documentation or to the existing docs. Please file an issue.

Policies

Open Source Policy

We adhere to the GSA Open Source Policy. If you have any questions, just post a question in the issue queue.

Security and Responsible Disclosure Policy

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.

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.