Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
40 lines (27 loc) · 2.81 KB

CONTRIBUTING.md

File metadata and controls

40 lines (27 loc) · 2.81 KB
Raw

Contributing

Before you consider contributing, please:

  • Read this contributing guide
  • Check the README for project overview and setup instructions
  • Review existing issues and pull requests
  • For major changes, open an issue first to discuss the approach

Criteria for Contributions and Feedback

This is a moderated platform. The U.S. Census Bureau will only accept contributions that are contributed per the terms of the license file. Contributors may submit links or materials for hosting in the repository. Upon submission, materials will be public and considered publicly available information, unless noted in the license file.

The U.S. Census Bureau reserves the right to reject, remove, or edit any contribution or feedback, including anything that:

  • states or implies endorsement of any entities, services, or products;
  • is inaccurate;
  • contains abusive or vulgar content, spam, hate speech, personal attacks, or similar content;
  • is clearly "off topic";
  • makes unsupported accusations;
  • includes personally identifiable or business identifiable information according to Department of Commerce Office of Privacy and Open Government guidelines; or,
  • contains .exe or .jar file types.

How to Contribute

There are two ways to contribute: 1) reporting issues or feature requests and 2) contributing code.

Issue Reports and Feature Requests

When reporting issues and feature requests, please use our Github issue templates.

Code Contributions

All new code contributions must include appropriate tests and require code review. The code review process is simple: open a Pull Request on GitHub and ensure all CI checks pass. One of the code owners will review your contribution.

Generative AI

We neither encourage nor prohibit AI code generation tools when contributing to this codebase. Please indicate in the Pull Request (PR) whether you used generative AI to create any part of the code. Generated code requires extra diligence. The time saved in generation is often offset by verification and review effort. Don't shift the burden of catching errors and understanding implementation details to maintainers; do this work before submitting.

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, you are agreeing to comply with this waiver of copyright interest.