Skip to content
5 changes: 5 additions & 0 deletions AGENTS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Clone Notes

- This is an isolated checkout for PR `#418` on `security-alliance/frameworks`.
- Edit `docs/pages/contribute/contributing.mdx` and regenerate the root `CONTRIBUTING.md` with `node utils/sync-contributing.js`.
- Keep Discord channel references aligned with the reviewer-approved `frameworks-contribs` wording.
71 changes: 38 additions & 33 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,36 +4,36 @@ This file is automatically synced from docs/pages/contribute/contributing.mdx du
⚠️ DO NOT EDIT THIS FILE DIRECTLY.
Instead, make changes to docs/pages/contribute/contributing.mdx and make this be synced just by running the build command.

Both files contain the same content: the docs file is there to render the content on the website, while this copy is
needed to make it highlighted in the repository dashboard.
Both files contain the same content: the docs file is there to render the content on the website,
while this copy is needed to make it highlighted in the repository dashboard.
-->

# **Contributing guidelines**

The Security Frameworks is an open and collaborative initiative. Whether you are part of the Security Alliance or not,
we welcome your contributions! Help us build the documentation and improve security in the blockchain ecosystem.

This handbook is designed for easy collaboration and automatic deployment through continuous integration.
If you'd like to join our effort, feel free to fix typos, contribute new sections, or propose enhancements.
This handbook is designed for easy collaboration and automatic deployment through continuous integration. If you'd like
to join our effort, feel free to fix typos, contribute new sections, or propose enhancements.

**Before contributing, please read our
[Code of Conduct](https://github.com/security-alliance/frameworks/blob/develop/CODE_OF_CONDUCT.md)**
to ensure that all interactions remain respectful, inclusive, and constructive.
**Before contributing, please read our [Code of
Conduct](https://github.com/security-alliance/frameworks/blob/develop/CODE_OF_CONDUCT.md)** to ensure that all
interactions remain respectful, inclusive, and constructive.

**Before contributing to SEAL Certifications** specifically, please read the [SEAL Certifications
Contributing Guide](/certs/contributions.mdx) for details on the certification framework and project specifics.

Join our [Discord](https://discord.gg/securityalliance) server, let others know what you are working on in the
frameworks-reviewers’ group channel, and collaborate with other contributors writing about related topics.
`frameworks-contribs` group channel, and collaborate with other contributors writing about related topics.

## Live versions

The source code for the Security Frameworks is hosted on GitHub:
[github.com/security-alliance/frameworks](https://github.com/security-alliance/frameworks).

- The **main branch** powers the stable Frameworks website
([https://frameworks.securityalliance.org/](https://frameworks.securityalliance.org/)) with reviewed and finalized
content.
([https://frameworks.securityalliance.org/](https://frameworks.securityalliance.org/)) with reviewed and
finalized content.
- The **development branch** ([https://frameworks.securityalliance.dev/](https://frameworks.securityalliance.dev/))
contains ongoing updates, new sections, and draft content.

Expand All @@ -50,26 +50,31 @@ First, check existing PRs or branches to make sure your work has not been previo
- Use the **“Contribute today!”** button at the bottom of any page
- Make fixes, formatting, and clarifications, favoring major modifications over just a few grammar mistakes
- Changes go through GitHub’s web interface without requiring local setup
- If someone already has an open PR, you can review the Cloudflare Pages preview linked from that PR and leave
proofreading or feedback on the PR itself without opening your own PR. This is a rendered preview for review, not a
separate commenting feature on the live site.

### 2. Add a new section or expand an existing one

All contributions should follow this workflow:

1. **Fork the repository** to your own GitHub account.
2. **Follow the [`template.mdx`](/docs/pages/config/template.mdx) page** when creating or expanding content.
It contains pre-defined components and structure required for consistency in MDX files.
2. **Follow the [`template.mdx`](https://github.com/security-alliance/frameworks/blob/develop/docs/pages/config/template.mdx)
page** when creating or expanding content. It contains pre-defined components and structure required for consistency
in MDX files.
3. **Make your changes** in MDX (typos, improvements, or new content) on your fork.
4. **Open a Pull Request (PR) against the `develop` branch** of this repository. Once submitted, you can see the
deployment through the automated preview and make any final adjustments.
4. **Open a Pull Request (PR) against the `develop` branch** of this repository. Once submitted, use the Cloudflare
Pages preview linked from the PR to verify the rendered site and make any final adjustments before review. All
feedback and discussion should stay on the PR itself.
5. **Notify reviewers** by tagging a steward or maintainer, requesting reviews directly in your PR.
6. Additionally, you can paste your PR and/or potential associated issues to the `framework-contribs` Discord channel.
6. Additionally, you can paste your PR and/or potential associated issues to the `frameworks-contribs` Discord channel.
7. Once reviewed and approved, your changes will be merged into `develop`.
8. Don't forget to add yourself to the YAML header of the file you're modifying, since that is how we provide
attribution. You should also create your profile inside the contributors list, at `docs/config/contributors.json`.
attribution. You should also create your profile inside the contributors list, at `docs/pages/config/contributors.json`.
9. Periodically, reviewed content from `develop` is merged into `main` for the stable site.

If you’re interested in a framework that doesn’t currently have an active steward, you can **become one yourself**.
See the [Stewards guide](/docs/pages/contribute/stewards.mdx) for details on responsibilities and how to get started.
If you’re interested in a framework that doesn’t currently have an active steward, you can **become one yourself**. See
the [Stewards guide](/docs/pages/contribute/stewards.mdx) for details on responsibilities and how to get started.

**⚠️ Please sign and verify all commits.** (If you have unsigned commits, follow the “Fixing Unsigned Commits” section
below to update them)
Expand All @@ -82,8 +87,8 @@ Choose the development approach that works best for you:

The easiest way to get started is using our pre-configured devcontainer with VSCode:

1. **Prerequisites**: VSCode with
[Dev Containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers)
1. **Prerequisites**: VSCode with [Dev Containers
extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers)
2. **Open the project**: VSCode will detect the devcontainer configuration
3. **Reopen in container**: Command Palette (Ctrl+Shift+P) → "Dev Containers: Reopen in Container"
4. **Start developing**: All tools are pre-installed and ready to use
Expand Down Expand Up @@ -142,14 +147,14 @@ If you prefer to install dependencies locally on your machine:

5. Once the server is running, access the site at port ```5173```

**(Optional) Authenticate with GitHub CLI**: The GitHub CLI (`gh`) is already preinstalled in the devcontainer.
You can authenticate by running `gh auth login` in the terminal, making it easy to interact with GitHub directly
from your development environment.
**(Optional) Authenticate with GitHub CLI**: The GitHub CLI (`gh`) is already preinstalled in the devcontainer. You can
authenticate by running `gh auth login` in the terminal, making it easy to interact with GitHub directly from your
development environment.

## Fixing unsigned commits

If you accidentally made unsigned commits in your fork, you’ll need to rewrite them so they show as **Verified**
before opening a PR.
If you accidentally made unsigned commits in your fork, you’ll need to rewrite them so they show as **Verified** before
opening a PR.

### 1. Rebase your recent commits

Expand Down Expand Up @@ -266,7 +271,7 @@ Contributors are **managed centrally**:

This helps track contributions and ensures proper attribution.

For a complete frontmatter example, see the [template file](/docs/pages/config/template.mdx).
For a complete frontmatter example, see the [template file](https://github.com/security-alliance/frameworks/blob/develop/docs/pages/config/template.mdx?plain=1).

### 2. Sidebar / Navigation

Expand Down Expand Up @@ -328,13 +333,13 @@ comparisons, or anecdotes to clarify complex topics.
### Content standardization

- Use **American English** consistently.
- Follow consistent terminology, capitalization, and nomenclature (see
[Ethereum.org style guide](https://ethereum.org/contributing/style-guide/content-standardization)).
- Usage of images and visualizations is encouraged. If you are using an image created by a third party,
make sure its license allows it and provide a link to the original. For creating your own visualizations,
we suggest [excalidraw.com](https://github.com/excalidraw/excalidraw).
- Feel free to use [emojis](https://docsify.js.org/#/emoji?id=emoji) or [icons](https://icongr.am/fontawesome)
where it fits, for example in block-quotes.
- Follow consistent terminology, capitalization, and nomenclature (see [Ethereum.org style
guide](https://ethereum.org/contributing/style-guide/content-standardization)).
- Usage of images and visualizations is encouraged. If you are using an image created by a third party, make sure its
license allows it and provide a link to the original. For creating your own visualizations, we suggest
[excalidraw.com](https://github.com/excalidraw/excalidraw).
- Feel free to use [emojis](https://docsify.js.org/#/emoji?id=emoji) or [icons](https://icongr.am/fontawesome) where it
fits, for example in block-quotes.

### Visual representation / drawings

Expand Down
18 changes: 11 additions & 7 deletions docs/pages/contribute/contributing.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ interactions remain respectful, inclusive, and constructive.
Contributing Guide](/certs/contributions.mdx) for details on the certification framework and project specifics.

Join our [Discord](https://discord.gg/securityalliance) server, let others know what you are working on in the
frameworks-reviewers’ group channel, and collaborate with other contributors writing about related topics.
`frameworks-contribs` group channel, and collaborate with other contributors writing about related topics.

## Live versions

Expand All @@ -62,6 +62,9 @@ PRs or branches to make sure your work has not been previously submitted.
- Use the **“Contribute today!”** button at the bottom of any page
- Make fixes, formatting, and clarifications, favoring major modifications over just a few grammar mistakes
- Changes go through GitHub’s web interface without requiring local setup
- If someone already has an open PR, you can review the Cloudflare Pages preview linked from that PR and leave
proofreading or feedback on the PR itself without opening your own PR. This is a rendered preview for review, not a
separate commenting feature on the live site.

### 2. Add a new section or expand an existing one

Expand All @@ -72,13 +75,14 @@ All contributions should follow this workflow:
page** when creating or expanding content. It contains pre-defined components and structure required for consistency
in MDX files.
3. **Make your changes** in MDX (typos, improvements, or new content) on your fork.
4. **Open a Pull Request (PR) against the `develop` branch** of this repository. Once submitted, you can see the
deployment through the automated preview and make any final adjustments.
4. **Open a Pull Request (PR) against the `develop` branch** of this repository. Once submitted, use the Cloudflare
Pages preview linked from the PR to verify the rendered site and make any final adjustments before review. All
feedback and discussion should stay on the PR itself.
5. **Notify reviewers** by tagging a steward or maintainer, requesting reviews directly in your PR.
6. Additionally, you can paste your PR and/or potential associated issues to the `framework-reviewers` Discord channel.
6. Additionally, you can paste your PR and/or potential associated issues to the `frameworks-contribs` Discord channel.
7. Once reviewed and approved, your changes will be merged into `develop`.
8. Don't forget to add yourself to the YAML header of the file you're modifying, given that is the way we provide
attribution. You should also create your profile inside the contributors list, at `docs/config/contributors.json`.
attribution. You should also create your profile inside the contributors list, at `docs/pages/config/contributors.json`.
9. Periodically, reviewed content from `develop` is merged into `main` for the stable site.

If you’re interested in a framework that doesn’t currently have an active steward, you can **become one yourself**. See
Expand Down Expand Up @@ -334,8 +338,8 @@ lecture](https://www.youtube.com/watch?v=vtIzMaLkCaM) to get started.
- Consider tutorials or hands-on guides for practical steps.
- Use visualizations (mermaid, diagrams, tables) to clarify concepts.
- Add recommended reading or dependencies at the top of a page if relevant.
- Focus on delivering credible, formal, technical content without unnecessary high-level introductions; use examples, comparisons, or anecdotes to clarify complex topics.

- Focus on delivering credible, formal, technical content without unnecessary high-level introductions; use examples,
comparisons, or anecdotes to clarify complex topics.
- You can use mermaid diagrams for visualizations

### Content standardization
Expand Down
Loading