Skip to content

cisagov/development-guide

Folders and files

NameName
Last commit message
Last commit date

Latest commit

658cb90 · Apr 9, 2025
Apr 9, 2025
Jun 30, 2023
Jun 30, 2023
Feb 20, 2020
Oct 22, 2024
Sep 12, 2023
Mar 10, 2025
Jun 7, 2023
Jul 18, 2023
May 3, 2019
Jun 2, 2021
Oct 19, 2020
Dec 4, 2024
Apr 1, 2025
Jun 7, 2019
Dec 4, 2024
Mar 6, 2024
Jun 24, 2019
Oct 22, 2024
Mar 10, 2025
May 19, 2023
Mar 10, 2025
Feb 3, 2020
Feb 3, 2020
Nov 20, 2024
Nov 6, 2024
Feb 25, 2022
Apr 4, 2025

Repository files navigation

development-guide

GitHub Build Status

A set of guidelines and best practices for an awesome engineering team. Heavily "inspired" by the 18F Development Guide.

Git, GitHub, and you

Tools and services we use

  • AWS - Our main cloud provider
  • CodeQL - Code analysis engine developed by GitHub to automate security checks and help prevent critical vulnerabilities. Replaces LGTM.
  • Coveralls - Test coverage tracking
  • Dependabot - Monitor vulnerabilities in dependencies and keep dependencies up-to-date
  • GitHub Actions - Continuous integration and delivery
  • PyPi - Python package publication

Installation

This guide has several supporting Python scripts. The simplest way to install these scripts and their dependencies is to use pip. In the root of this project execute:

pip install -r requirements.txt

Please see the Creating the Python virtual environment section of the CONTRIBUTING document for information about setting up these scripts in a Python virtual environment.

Contributing

We welcome contributions! Please see CONTRIBUTING.md for details.

License

This project is in the worldwide 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.