Skip to content
This repository has been archived by the owner on Aug 6, 2021. It is now read-only.

Latest commit

 

History

History
28 lines (21 loc) · 3.63 KB

CONTRIBUTING.md

File metadata and controls

28 lines (21 loc) · 3.63 KB
Raw

Welcome!

We're so glad you're thinking about contributing to a U.S. Government open source project! 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 love all friendly contributions.

How to contribute to this project

  • We want to ensure a welcoming environment for all of our projects. Our staff follows this Code of Conduct and all contributors should do the same.
  • Report bugs and request features via Github Issues
  • Email us your ideas on how to improve the code-gov-front-end. We're always open to suggestions.
  • Create a Github pull request with new functionality or fixing a bug.
  • Improve or create documentation.
  • Help us improve our tests.
  • Triage tickets and review patches triaging-tickets created by other users.

Public domain

As noted in LICENSE, this project is in the worldwide public domain (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.

Issue Guidelines

In the interest of making it easier for our contributors to manage site issues, we request that issues follow certain guidelines. Our developers mainly use issues to identify and prioritize their work. If you have questions about code.gov or would like start a general discussion, we kindly request that you email us at code@gsa.gov. Our issue guidelines are a living document and a work in progress, so feel free to offer feedback on it, by emailing us at code@gsa.gov

  • Specific: The issue makes specific requests. An example of a specific request would be Reduce the Size of Images. An example of a non-specific request would be Improve Site Performance.
  • Measurable: The issue has specific requirements and can be closed when those requirements are met. This helps us track the progress in addressing problems. For example, tech debt is always something to work on, so we should create separate issues for this, such as Consolidate Styling of Repo and Task Cards and Convert Validator from Monaco Editor to jsoneditor, rather than Address Tech Debt.
  • Actionable: An issue should request a specific action from a member of the code.gov team or community. An example of something actionable would be Remove Debugging Text from Loading Screen. An example of something that isn't actionable by our team or community is My city should be forking Code.gov.
  • Realistic: The issue is something that is achievable by the resources of the project, including contributions from the open source community. An example of a realistic issue is Include Line Numbers in Validator.
  • Time-Aware: The issue is something that can be resolved within 6 months. If you think your issue might take longer, we encourage you to break up your issues into smaller issues (like stepping stones) that we can address. We can still work on big problems, but it is easier for us to track progress and identify what we need to work on, when big problems are broken up into smaller ones.