diff --git a/README.md b/README.md index 8b13789..c33cff0 100644 --- a/README.md +++ b/README.md @@ -1 +1,29 @@ +# .github +This repository contains the organization-wide default community health files and workflow templates for **cks-code**. + +GitHub uses files in this repository as defaults for all repositories in the organization that do not define their own. + +## Files + +| File | Purpose | +|------|---------| +| [`profile/README.md`](profile/README.md) | Organization profile displayed on the cks-code GitHub page | +| [`CODE_OF_CONDUCT.md`](CODE_OF_CONDUCT.md) | Default code of conduct for all repositories | +| [`SECURITY.md`](SECURITY.md) | Default security and responsible disclosure policy | +| [`FUNDING.yml`](FUNDING.yml) | Funding/sponsorship configuration | +| [`workflow-templates/`](workflow-templates/) | Reusable GitHub Actions workflow templates | + +## Workflow Templates + +The [`workflow-templates/`](workflow-templates/) directory contains the following reusable workflows: + +- **[`build-lint-test.yml`](workflow-templates/build-lint-test.yml)** — Build, lint, and test pipeline for Node.js projects +- **[`create-release-pr.yml`](workflow-templates/create-release-pr.yml)** — Workflow to create a release pull request +- **[`publish-release.yml`](workflow-templates/publish-release.yml)** — Workflow to publish a release when a release PR is merged + +## Usage + +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. + +Workflow templates stored in `workflow-templates/` can be used by any repository in the organization via the **Actions** tab → **New workflow**. diff --git a/profile/README.md b/profile/README.md index 26c7ace..317112c 100644 --- a/profile/README.md +++ b/profile/README.md @@ -1,9 +1,24 @@ -# MetaMask +# cks-code -The web3 crypto wallet and browser extension! +Welcome to the **cks-code** GitHub organization! -If you want to report a security issue, please [submit it securely on our HackerOne bounty program](https://hackerone.com/metamask?type=team). +This organization hosts a collection of repositories for our projects and components. -You can find the code for our various products and components in this org. +## Community & Contributing -For general information, visit [metamask.io](https://metamask.io). +We value open collaboration and welcome contributions. Before getting involved, please review our community standards: + +- 📋 [Code of Conduct](../CODE_OF_CONDUCT.md) — Standards for participation in our community +- 🔒 [Security Policy](../SECURITY.md) — How to responsibly report security vulnerabilities + +## Workflow Templates + +We provide reusable [workflow templates](../workflow-templates/) to help standardize CI/CD across repositories: + +- **Build, Lint, and Test** — Automated build, lint, and test pipeline +- **Create Release Pull Request** — Automate the creation of release pull requests +- **Publish Release** — Publish a new release when a release PR is merged + +## Support + +If you have questions or need help, feel free to open an issue in the relevant repository.