Skip to content

Core project documentation artifacts to include in every CivicActions project

License

Notifications You must be signed in to change notification settings

CivicActions/civic-project-template

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

17 Commits
 
 
 
 
 
 
 
 

Repository files navigation

[Project Name] Overview

Description

This is a stub repository to begin to outline minimum project documentation artifacts. The README.md file should provide all participants with core information about where project design / development / documention / code artifacts reside, and should be updated to ensure it contains all the information a new developer, project manager or project owner should need to take control of, and continue development of the project.

Objectives

To create a core set of documentation artifacts that should be present in EVERY CivicActions project that has code associated with it.

##Staff

Product owners

Jane Doe, US Dept of Commerce, [email protected]

Project managers

Joe Manager, CivicActions, [email protected]

Developers

Sarah Devo, CivicActions, [email protected], backend

James Draw, Civicactions, [email protected], front-end

Sites and repos

Prod

https://testsite.commerce.gov

Stage

https://stage.testsite.commerce.gov

Dev

https://dev.teststite.commerce.gov

Code Repository

[email protected]:Civicactions/project-documentation.git

Example Documentation Table of Contents

  1. Sandbox setup
  2. [Governance] (documentation/governance)
  3. Custom_form module documentation

Notes

About

Core project documentation artifacts to include in every CivicActions project

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published