cisagov/development-guide

A set of guidelines and best practices for an awesome engineering team

development-guide

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

• Open Source Policy

• Project Setup
• Development Environments
  • CISA-provided Mac Setup
• Language Guides
  • HCL
  • JavaScript
  • Python

Git, GitHub, and you

• FISMA-Ready GitHub account setup
• How to Write a Git Commit Message
• How to Review Code Effectively

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.