Skip to content
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.

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

Help Desk: Added GitHub Repository-Level Requests #269

Closed
wants to merge 25 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
0179a5c
Add team request to issue templates
natalialuzuriaga Mar 13, 2025
1860320
Add outside collaborator request issue template
natalialuzuriaga Mar 13, 2025
bc0f30c
Add third party integration issue template request
natalialuzuriaga Mar 13, 2025
fe08785
Update labels for help desk issue templates
natalialuzuriaga Mar 18, 2025
54c903e
Remove tier 1 help desk issue templates
natalialuzuriaga Mar 18, 2025
284a620
Updated role information in help desk tickets
natalialuzuriaga Mar 18, 2025
8befdfd
Removed CODEOWNERS.md + MAINTAINERS.md and added code.json and COMMUN…
natalialuzuriaga Mar 6, 2025
b14b51b
Updated table with new values
natalialuzuriaga Mar 13, 2025
65f66dc
Remove escape character
natalialuzuriaga Mar 13, 2025
045803c
Updated table with new COMMUNITY.md and code.json sections
natalialuzuriaga Mar 13, 2025
7580204
Add link to code.json schema
natalialuzuriaga Mar 13, 2025
c89c006
Updated links in section table
natalialuzuriaga Mar 13, 2025
c1b49e4
Remove mentions of MAINTAINERS.md
natalialuzuriaga Mar 13, 2025
70cd9af
Move CODEOWNERS.md to .github for all tiers
natalialuzuriaga Mar 13, 2025
7c35250
Updated documentation on contents of .github
natalialuzuriaga Mar 13, 2025
596e2dd
Remove MAINTAINERS.md from all tiers
natalialuzuriaga Mar 13, 2025
98a8a2a
Added COMMUNITY.md
natalialuzuriaga Mar 18, 2025
22f0b34
Updated GOVERNANCE.md
natalialuzuriaga Mar 19, 2025
c291ea1
Update COMMUNITY.md with edits
natalialuzuriaga Mar 19, 2025
0ef476e
Remove COMMUNITY_GUIDELINES.md
natalialuzuriaga Mar 19, 2025
55caced
Updated .github docs
natalialuzuriaga Mar 19, 2025
3a5ffb9
Added Tier 0 column to docs
natalialuzuriaga Mar 19, 2025
863e96c
Updated maturity model tiers docs
natalialuzuriaga Mar 19, 2025
21305a7
Fixed project team table in COMMUNITY.md
natalialuzuriaga Mar 19, 2025
b753ecc
Added docs on help desk requests
natalialuzuriaga Mar 25, 2025
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
38 changes: 38 additions & 0 deletions docs/.github-directory.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# `.github` directory

The .github directory in repository templates contains files and workflows designed to support project teams with development, documentation, and repository hygiene. This includes GitHub Actions workflows for automated tasks, metadata files for project information, and more.

## Workflows

Located in .**github/workflows**, the OSPO has created GitHub Actions workflows to assist project teams with development and documentation upkeep for repository hygiene.

| File Name | Tier 0 | Tier 1 | Tier 2 | Tier 3 | Tier 4 | Description |
| :------------------------------------------------------------------------------------------------------------------------------------------------------------- | :----- | :----- | :----- | :----- | :----- | :----------------------------------------------- |
| [auto-changelog.yml](https://github.com/DSACMS/repo-scaffolder/blob/main/tier3/%7B%7Bcookiecutter.project_slug%7D%7D/.github/workflows/auto-changelog.yml) | | | ✔️ | ✔️ | ✔️ | Auto-generates a CHANGELOG.md |
| [repoHygieneCheck.yml](https://github.com/DSACMS/repo-scaffolder/blob/main/tier3/%7B%7Bcookiecutter.project_slug%7D%7D/.github/workflows/repoHygieneCheck.yml) | | ✔️ | ✔️ | ✔️ | ✔️ | Performs repolinter checks |
| [contributors.yml](https://github.com/DSACMS/repo-scaffolder/blob/main/tier3/%7B%7Bcookiecutter.project_slug%7D%7D/.github/workflows/contributors.yml) | | | ✔️ | ✔️ | ✔️ | Generates a list of contributors in COMMUNITY.md |
| [gitleaks.yml](https://github.com/DSACMS/repo-scaffolder/blob/main/tier3/%7B%7Bcookiecutter.project_slug%7D%7D/.github/workflows/gitleaks.yml) | | ✔️ | ✔️ | ✔️ | ✔️ | Scans for secrets upon each push or PR |
| [repoStructure.yml](https://github.com/DSACMS/repo-scaffolder/blob/main/tier3/%7B%7Bcookiecutter.project_slug%7D%7D/.github/workflows/repoStructure.yml) | | | | ✔️ | ✔️ | Generates repo structure in README.md |

## Project Metadata: Adding code.json to your repository using cookiecutter

Located in `.github/codejson` are files needed to add metadata to your repository using cookiecutter. Follow these set of [instructions](https://github.com/DSACMS/repo-scaffolder?tab=readme-ov-file#metadata-collection-using-codejson) to create code.json.

## Files

`.github` contains additional files that can be helpful to add to your repository.

| File Name | Tier 0 | Tier 1 | Tier 2 | Tier 3 | Tier 4 | Description |
| :------------------------------------------------------------------------------------------------------------------------------------- | :----- | :----- | :----- | :----- | :----- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [CODEOWNERS.md](https://github.com/DSACMS/repo-scaffolder/blob/main/tier3/%7B%7Bcookiecutter.project_slug%7D%7D/.github/CODEOWNERS.md) | | | ✔️ | ✔️ | ✔️ | A file used to define who is responsible for specific parts of the codebase. Learn more in [GitHub Docs](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners). |

## Help Desk Requests

Located in `.github/ISSUE_TEMPLATES` are issue templates to make requests for repository access and metadata updates. Requests are managed by the repository admins and organization owners. Refer to the [GitHub Manangement Policy](https://dsacms.github.io/ospo-guide/resources/github-management-policy/#github-organization-access-1) for more information.

| File Name | Description |
| ------------------------------- | --------------------------------------------------------- |
| add_team_request.md | Request team to be added to repository |
| outside_collaborator_request.md | Request outside collaborator to be added to repository |
| integration_request.md | Request third-party integration to be added to repository |
| code_json_request.md | Request updates to code.json |
11 changes: 0 additions & 11 deletions docs/workflows.md

This file was deleted.

Loading