Skip to content

Commit 6a6f8ff

Browse files
🔄 synced local './README.md' with remote './tier2/{{cookiecutter.project_slug}}/README.md'
1 parent 2127e8d commit 6a6f8ff

1 file changed

Lines changed: 34 additions & 4 deletions

File tree

‎README.md‎

Lines changed: 34 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,17 @@
55
## About the Project
66

77
**{project statement}**
8+
<!-- TODO: Write an about statement for this project. -->
89

910
### Project Vision
1011

1112
**{project vision}**
13+
<!-- TODO: What is the vision for this project -->
1214

1315
### Project Mission
1416

1517
**{project mission}**
18+
<!-- TODO: Mission statement -->
1619

1720
### Agency Mission
1821

@@ -31,6 +34,24 @@ A list of core team members responsible for the code and documentation in this r
3134
3235
TODO: Including the repository structure helps viewers quickly understand the project layout. Using the "tree -d" command can be a helpful way to generate this information, but, be sure to update it as the project evolves and changes over time.
3336
37+
To install the tree command:
38+
In the command line
39+
- MacOS:
40+
```
41+
brew install tree
42+
```
43+
44+
- Linux:
45+
```
46+
sudo apt-get update
47+
sudo apt-get install tree
48+
```
49+
50+
Windows:
51+
```
52+
choco install tree
53+
```
54+
3455
**{list directories and descriptions}**
3556
3657
TODO: Add a 'table of contents" for your documentation. Tier 0/1 projects with simple README.md files without many sections may or may not need this, but it is still extremely helpful to provide "bookmark" or "anchor" links to specific sections of your file to be referenced in tickets, docs, or other communication channels.
@@ -39,15 +60,24 @@ TODO: Add a 'table of contents" for your documentation. Tier 0/1 projects with s
3960
4061
-->
4162

42-
<!--
43-
# Development and Software Delivery Lifecycle
44-
The following guide is for members of the project team who have access to the repository as well as code contributors. The main difference between internal and external contributions is that external contributors will need to fork the project and will not be able to merge their own pull requests. For more information on contributing, see: [CONTRIBUTING.md](./CONTRIBUTING.md).
63+
<!-- TODO
64+
## Development and Software Delivery Lifecycle
65+
This section provides an overview of how this project typically manages code changes and delivers software updates. It is intended to help contributors understand the general flow of work, not to set mandatory procedures. Programs and teams may adjust these practices to meet their own requirements, governance structures, or release schedules.
66+
67+
Project team members with write access work directly in this repository. External contributors follow the same general workflow but submit changes through a fork and cannot merge their own pull requests. Additional guidance for contributing is available in:
68+
[CONTRIBUTING.md](./CONTRIBUTING.md).
69+
70+
This project aligns with the organization’s common approach to versioning, preparing releases, and communicating updates. Rather than restating those details here, please refer to the OSPO Release Guidelines:
71+
72+
[Release Guidelines (OSPO Guide)](https://dsacms.github.io/ospo-guide/outbound/release-guidelines/)
73+
74+
These guidelines outline agency-wide expectations for semantic versioning, release candidates, GitHub releases, and associated review and communication practices. Individual projects may follow this model in full or tailor it to their operational needs.
4575
-->
4676

4777
## Local Development
4878

4979
<!--- TODO - with example below:
50-
This project is monorepo with several apps. Please see the [api](./api/README.md) and [frontend](./frontend/README.md) READMEs for information on spinning up those projects locally. Also see the project [documentation](./documentation) for more info.
80+
This project is a monorepo with several apps. Please see the [api](./api/README.md) and [frontend](./frontend/README.md) READMEs for information on spinning up those projects locally. Also see the project [documentation](./documentation) for more info.
5181
-->
5282

5383
## Coding Style and Linters

0 commit comments

Comments
 (0)