batmanwgd / development-guide Goto Github PK

18F Engineering Practices

18F promotes team best practices across specialty areas through guilds. These guilds support their members in whatever way deemed most appropriate by those members themselves.

This repo is where the Engineering Practices Guild keeps its guide to best practices and resources for software development.

Quicklinks

• Guide: https://engineering.18f.gov/
• CONTRIBUTING.md on how to build this guide locally and submitting PRs/issues.

Our mission

We believe that government websites should be functional, maintainable, and thoughtfully designed. Our guild helps TTS promote the adoption and advancement of software development best practices. In this way, TTS can lead by example while providing effective services that help our partners and customers fulfill their missions. To achieve our vision, the Engineering Practices Guild works to:

• Support the continuous learning necessary for successful software engineering work.
• Provide TTS developers with easy-to-understand, actionable guidance around software engineering best practices.
• Promote a central knowledge base of shared tools and common patterns.
• Create a healthy and supportive internal environment so that we can, in turn, bolster healthy external communities related to our work.

How to track what we're doing, and how you can be involved!

We use issues in this repo to track work. If you'd like to suggest a new topic or flag an issue, please file an issue.

The software development industry is ever-changing, and our guide is a living document. Please suggest edits or changes via pull request.

Public domain

This project is in the worldwide public domain. As stated in CONTRIBUTING:

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.