Skip to content

Commit 1f6f18f

Browse files
authored
Merge pull request #2 from cks-code/copilot/consolidate-repo-files
2 parents 36a7b64 + b72361c commit 1f6f18f

2 files changed

Lines changed: 48 additions & 5 deletions

File tree

README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,29 @@
1+
# .github
12

3+
This repository contains the organization-wide default community health files and workflow templates for **cks-code**.
4+
5+
GitHub uses files in this repository as defaults for all repositories in the organization that do not define their own.
6+
7+
## Files
8+
9+
| File | Purpose |
10+
|------|---------|
11+
| [`profile/README.md`](profile/README.md) | Organization profile displayed on the cks-code GitHub page |
12+
| [`CODE_OF_CONDUCT.md`](CODE_OF_CONDUCT.md) | Default code of conduct for all repositories |
13+
| [`SECURITY.md`](SECURITY.md) | Default security and responsible disclosure policy |
14+
| [`FUNDING.yml`](FUNDING.yml) | Funding/sponsorship configuration |
15+
| [`workflow-templates/`](workflow-templates/) | Reusable GitHub Actions workflow templates |
16+
17+
## Workflow Templates
18+
19+
The [`workflow-templates/`](workflow-templates/) directory contains the following reusable workflows:
20+
21+
- **[`build-lint-test.yml`](workflow-templates/build-lint-test.yml)** — Build, lint, and test pipeline for Node.js projects
22+
- **[`create-release-pr.yml`](workflow-templates/create-release-pr.yml)** — Workflow to create a release pull request
23+
- **[`publish-release.yml`](workflow-templates/publish-release.yml)** — Workflow to publish a release when a release PR is merged
24+
25+
## Usage
26+
27+
Community health files (e.g. `CODE_OF_CONDUCT.md`, `SECURITY.md`) stored here will automatically apply to all repositories in the `cks-code` organization that do not have their own copy.
28+
29+
Workflow templates stored in `workflow-templates/` can be used by any repository in the organization via the **Actions** tab → **New workflow**.

profile/README.md

Lines changed: 20 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,24 @@
1-
# MetaMask
1+
# cks-code
22

3-
The web3 crypto wallet and browser extension!
3+
Welcome to the **cks-code** GitHub organization!
44

5-
If you want to report a security issue, please [submit it securely on our HackerOne bounty program](https://hackerone.com/metamask?type=team).
5+
This organization hosts a collection of repositories for our projects and components.
66

7-
You can find the code for our various products and components in this org.
7+
## Community & Contributing
88

9-
For general information, visit [metamask.io](https://metamask.io).
9+
We value open collaboration and welcome contributions. Before getting involved, please review our community standards:
10+
11+
- 📋 [Code of Conduct](../CODE_OF_CONDUCT.md) — Standards for participation in our community
12+
- 🔒 [Security Policy](../SECURITY.md) — How to responsibly report security vulnerabilities
13+
14+
## Workflow Templates
15+
16+
We provide reusable [workflow templates](../workflow-templates/) to help standardize CI/CD across repositories:
17+
18+
- **Build, Lint, and Test** — Automated build, lint, and test pipeline
19+
- **Create Release Pull Request** — Automate the creation of release pull requests
20+
- **Publish Release** — Publish a new release when a release PR is merged
21+
22+
## Support
23+
24+
If you have questions or need help, feel free to open an issue in the relevant repository.

0 commit comments

Comments
 (0)