Skip to content

Minor doc fixes #125

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
borrow-checker wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Minor doc fixes #125

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,9 +99,9 @@ Additionally, we use `prettier` for code formatting.

## Branching Model

This project follows [trunk-based development](https://trunkbaseddevelopment.com/), which means:
This project follows [Github Flow](https://guides.github.com/introduction/flow/), which means:

- Make small changes in [short-lived feature branches](https://trunkbaseddevelopment.com/short-lived-feature-branches/) and merge to `main` frequently.
- Make small changes in [short-lived feature branches](https://guides.github.com/introduction/flow/) and merge to `origin/main` frequently.
- Be open to submitting multiple small pull requests for a single ticket (i.e. reference the same ticket across multiple pull requests).
- Treat each change you merge to `main` as immediately deployable to production. Do not merge changes that depend on subsequent changes you plan to make, even if you plan to make those changes shortly.
- Ticket any unfinished or partially finished work.
Expand Down
4 changes: 2 additions & 2 deletions content/growing/how-to-work-at-dsac.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ To oversee repository operations in DSACMS, the OSPO follows the GitHub Manageme
Generally, DSAC repositories adhere to the following workflow standards to streamline collaboration.

**Branching**
We follow the [GitHub Flow Workflow]([https://guides.github.com/introduction/flow/).
We follow the [GitHub Flow Workflow](https://guides.github.com/introduction/flow/).

**Sending in PRs**
When making pull requests, information specified in our [PULL\_REQUEST\_TEMPLATE.md](https://github.com/DSACMS/repo-scaffolder/blob/main/tier3/%7B%7Bcookiecutter.project_slug%7D%7D/.github/PULL_REQUEST_TEMPLATE.md%20) must be included. A set of checks (e.g. CodeQL, gitleaks, [OSPO workflows](https://github.com/DSACMS/repo-scaffolder/blob/main/docs/.github-directory.md#workflows%20)) will be run to verify contents of the code change.
Expand Down Expand Up @@ -164,7 +164,7 @@ CMS's cloud infrastructure platform built on AWS that provides essential cloud s

Visit: [https://cloud.cms.gov/](https://cloud.cms.gov/)

**Synk**
**Snyk**
A security scanning tool for identifying vulnerabilities in code dependencies and container images. CMS uses it as part of their vulnerability management and security testing processes.

Visit: [https://snyk.io/](https://snyk.io/)
Expand Down