You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
2.**Open the project**: VSCode will detect the devcontainer configuration
88
93
3.**Reopen in container**: Command Palette (Ctrl+Shift+P) → "Dev Containers: Reopen in Container"
89
94
4.**Start developing**: All tools are pre-installed and ready to use
@@ -142,14 +147,14 @@ If you prefer to install dependencies locally on your machine:
142
147
143
148
5. Once the server is running, access the site at port ```5173```
144
149
145
-
**(Optional) Authenticate with GitHub CLI**: The GitHub CLI (`gh`) is already preinstalled in the devcontainer.
146
-
You can authenticate by running `gh auth login`in the terminal, making it easy to interact with GitHub directly
147
-
from your development environment.
150
+
**(Optional) Authenticate with GitHub CLI**: The GitHub CLI (`gh`) is already preinstalled in the devcontainer. You can
151
+
authenticate by running `gh auth login`in the terminal, making it easy to interact with GitHub directly from your
152
+
development environment.
148
153
149
154
## Fixing unsigned commits
150
155
151
-
If you accidentally made unsigned commits in your fork, you’ll need to rewrite them so they show as **Verified**
152
-
before opening a PR.
156
+
If you accidentally made unsigned commits in your fork, you’ll need to rewrite them so they show as **Verified** before
157
+
opening a PR.
153
158
154
159
### 1. Rebase your recent commits
155
160
@@ -266,7 +271,7 @@ Contributors are **managed centrally**:
266
271
267
272
This helps track contributions and ensures proper attribution.
268
273
269
-
For a complete frontmatter example, see the [template file](/docs/pages/config/template.mdx).
274
+
For a complete frontmatter example, see the [template file](https://github.com/security-alliance/frameworks/blob/develop/docs/pages/config/template.mdx?plain=1).
270
275
271
276
### 2. Sidebar / Navigation
272
277
@@ -328,13 +333,13 @@ comparisons, or anecdotes to clarify complex topics.
328
333
### Content standardization
329
334
330
335
- Use **American English** consistently.
331
-
- Follow consistent terminology, capitalization, and nomenclature (see
Copy file name to clipboardExpand all lines: docs/pages/contribute/contributing.mdx
+11-7Lines changed: 11 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -36,7 +36,7 @@ interactions remain respectful, inclusive, and constructive.
36
36
Contributing Guide](/certs/contributions.mdx) for details on the certification framework and project specifics.
37
37
38
38
Join our [Discord](https://discord.gg/securityalliance) server, let others know what you are working on in the
39
-
‘frameworks-reviewers’ group channel, and collaborate with other contributors writing about related topics.
39
+
`frameworks-contribs` group channel, and collaborate with other contributors writing about related topics.
40
40
41
41
## Live versions
42
42
@@ -62,6 +62,9 @@ PRs or branches to make sure your work has not been previously submitted.
62
62
- Use the **“Contribute today!”** button at the bottom of any page
63
63
- Make fixes, formatting, and clarifications, favoring major modifications over just a few grammar mistakes
64
64
- Changes go through GitHub’s web interface without requiring local setup
65
+
- If someone already has an open PR, you can review the Cloudflare Pages preview linked from that PR and leave
66
+
proofreading or feedback on the PR itself without opening your own PR. This is a rendered preview for review, not a
67
+
separate commenting feature on the live site.
65
68
66
69
### 2. Add a new section or expand an existing one
67
70
@@ -72,13 +75,14 @@ All contributions should follow this workflow:
72
75
page** when creating or expanding content. It contains pre-defined components and structure required for consistency
73
76
in MDX files.
74
77
3.**Make your changes** in MDX (typos, improvements, or new content) on your fork.
75
-
4.**Open a Pull Request (PR) against the `develop` branch** of this repository. Once submitted, you can see the
76
-
deployment through the automated preview and make any final adjustments.
78
+
4.**Open a Pull Request (PR) against the `develop` branch** of this repository. Once submitted, use the Cloudflare
79
+
Pages preview linked from the PR to verify the rendered site and make any final adjustments before review. All
80
+
feedback and discussion should stay on the PR itself.
77
81
5.**Notify reviewers** by tagging a steward or maintainer, requesting reviews directly in your PR.
78
-
6. Additionally, you can paste your PR and/or potential associated issues to the `framework-reviewers` Discord channel.
82
+
6. Additionally, you can paste your PR and/or potential associated issues to the `frameworks-contribs` Discord channel.
79
83
7. Once reviewed and approved, your changes will be merged into `develop`.
80
84
8. Don't forget to add yourself to the YAML header of the file you're modifying, given that is the way we provide
81
-
attribution. You should also create your profile inside the contributors list, at `docs/config/contributors.json`.
85
+
attribution. You should also create your profile inside the contributors list, at `docs/pages/config/contributors.json`.
82
86
9. Periodically, reviewed content from `develop` is merged into `main` for the stable site.
83
87
84
88
If you’re interested in a framework that doesn’t currently have an active steward, you can **become one yourself**. See
@@ -334,8 +338,8 @@ lecture](https://www.youtube.com/watch?v=vtIzMaLkCaM) to get started.
334
338
- Consider tutorials or hands-on guides for practical steps.
335
339
- Use visualizations (mermaid, diagrams, tables) to clarify concepts.
336
340
- Add recommended reading or dependencies at the top of a page if relevant.
337
-
- Focus on delivering credible, formal, technical content without unnecessary high-level introductions; use examples, comparisons, or anecdotes to clarify complex topics.
338
-
341
+
- Focus on delivering credible, formal, technical content without unnecessary high-level introductions; use examples,
342
+
comparisons, or anecdotes to clarify complex topics.
0 commit comments