Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
137 lines (87 loc) · 4.9 KB

CONTRIBUTING.md

File metadata and controls

137 lines (87 loc) · 4.9 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

Team Specific Guidelines

This repository is maintained by the Digital Services at CMS (DSACMS).
For details on contributors, see COMMUNITY.md.

Building dependencies

To install dependencies:

git clone https://github.com/dsacms/code-gov.git
cd code-gov
npm install

Building the Project

To build locally:

npm run build

For local development with hot reload:

npm start

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

Coding Style and Linters

We enforce consistent coding style with automated tools:

  1. Code must follow Prettier formatting
  2. Linting is enforced with ESLint
  3. Commit messages must follow Conventional Commits

Before submitting run:

npm run lint
npm run format

Writing Issues

When creating an issue, please use the format providede with our issue templates.

Writing Pull Requests

Pull requests should:

Be filed against the main branch.

Include a clear description of the problem, solution, and result.

Follow the Conventional Commits guidelines noted above.

See our pull request template for more

Reviewing Pull Requests

Pull requests are reviewed by the maintainers listed in COMMUNITY.md. Reviews may include feedback on style, functionality, security, and documentation.

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

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.