Skip to content

Commit 24b4025

Browse files
committed
fix: review update
1 parent 79c5b00 commit 24b4025

4 files changed

Lines changed: 11 additions & 11 deletions

File tree

CONTRIBUTING.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ your contribution is aligned with the project's goals.
2525

2626
##### Windows and repository symlinks
2727

28-
Some paths in this repo are **symbolic links** so tools can reach shared skills without needing to host multiple versions of the same files. For example, `.agents/skills` and `.claude/skills` point at `guidelines/skills`. On **Windows**, Git may create **regular folders or files** instead of links, so these locations can look empty or broken.
28+
Some paths in this repo are **symbolic links** so tools can reach shared skills without needing to host multiple versions of the same files. For example, `.agents/skills` and `.claude/skills` point to `guidelines/skills`. On **Windows**, Git may create **regular folders or files** instead of links, so these locations can look empty or broken.
2929

3030
**Before you clone the repository**
3131

@@ -35,7 +35,7 @@ Some paths in this repo are **symbolic links** so tools can reach shared skills
3535
**If the repo is already on disk and the links are broken**
3636

3737
Turning on Developer Mode or Git symlink settings **does not always fix** paths Git has already created as ordinary files.
38-
- Delete the broken `.agents/skills` and `.claude/skills` entries, or remove the entire folder/directory and **clone again**
38+
- Delete the broken `.agents/skills` and `.claude/skills` entries, or remove the entire folder/directory and **clone again**.
3939
- Then follow the **Before you clone the repository** steps above
4040

4141
> If you are unsure of any steps, please verify them with your IT or system administrator before proceeding.
@@ -56,7 +56,7 @@ Our process follows the standard GitHub fork and pull request workflow.
5656
- Submit a pull request towards the main repository default branch
5757

5858
##### Main repository branches
59-
- The `main` branch currently represents both development and stable releases
59+
- The `main` branch currently represents both development and stable releases.
6060

6161
> In the future, if there is an increase in contributions, we may consider implementing a `stable` branch.
6262
> - `main` would be the default branch for development and feature work rebased from `stable` after release.
@@ -184,7 +184,7 @@ For detailed information on agent interaction, see [guidelines/README.md](./guid
184184
#### Customizing developer experience
185185

186186
As developers, we often have our own preferred workflows, and that includes working with AI agents. To that point, we've added agent guidance
187-
to allow customization for your work environment through a tool-agnostic git-ignored directory `./.agent` in the root of the project.
187+
to allow customization for your work environment through a tool-agnostic gitignored directory `./.agent` in the root of the project.
188188

189189
#### Noting AI agent contributions
190190

GOVERNANCE.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,10 @@ GitHub workflows perform checks for
99
- Spelling and linting for most files
1010
- Unit testing
1111
- E2E testing
12-
- Dependency Auditing: Automated `npm audit` checks to identify and block critical-risk vulnerabilities in the project's dependency tree, running on every dependency change and daily thereafter.
12+
- Dependency Auditing: Automated `npm audit` checks to identify critical-risk vulnerabilities in the project's dependency tree, running on every dependency change and daily thereafter.
1313
- Conditional Data Auditing: If and when related files are updated, an automated audit verifies the integrity and reachability of PatternFly documentation entries.
1414

15-
> Core contributors may receive an automated pass on Layer-1 policy checks when the workflow makes an allowance. This pass does not remove the remaining steps of automated review, nor the later layers of review and runtime boundaries.
15+
> Layer-1 policy feedback may be handled at the maintainer or organization level for established contributors. Any such discretion applies only to how policy findings are triaged; it does not extend to waiving automated checks, human review (Layer 2), or runtime boundaries (Layer 3).
1616
1717
## Layer 2: Human Review
1818

@@ -31,4 +31,4 @@ The PatternFly MCP server implements security at the execution level:
3131

3232
## What This Means in Practice
3333

34-
No single automated check or individual contributor can bypass the security chain. A malicious or accidental change must pass Layer-1, a Human Maintainer (Layer 2), and still operate within the Sandbox (Layer 3) to affect a user.
34+
No single automated check or individual contributor can bypass the security chain. A malicious or accidental change must pass Layer-1, a Human maintainer (Layer 2), and still operate within the Sandbox (Layer 3) to affect a user.

SECURITY.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Security concerns for this MCP server include:
2020
To maintain codebase integrity:
2121
- PRs from non-core contributors that modify core behavior or exceed recommended file limits are considered placed on **Policy Hold** until they are reviewed in-depth to ensure architectural alignment.
2222
- PRs from community contributors can refer to the mirrored guidance and status in the **GitHub Actions workflow logs** for helpful feedback.
23-
- PRs require a secondary review by a Maintainer to be promoted from Policy Hold status.
23+
- PRs require a secondary review by a maintainer to be promoted from Policy Hold status.
2424

2525
## Release Integrity
2626

docs/architecture.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ this actively plays a role in the library architecture because it allows us to f
5353

5454
Key goals aided by moving towards plugins:
5555
- **Providing a tailored experience for users** - Plugins a designer uses may differ from those of a developer, researcher, or community member.
56-
- **Evolving/future proofing** - Plugins can evolve over time, and the MCP server can evolve to support them. (e.g., a new JS framework or design framework, etc.)
56+
- **Evolving/future-proofing** - Plugins can evolve over time, and the MCP server can evolve to support them. (e.g., a new JS framework or design framework)
5757
- **Maintainability** - MCP server core can focus on features and issues while plugins are added and maintained by the community.
5858

5959
## Server architecture
@@ -94,7 +94,7 @@ Our roadmap focuses on expanding the server's reach and providing a more integra
9494
- **Experimental Context Management**: Streamlining MCP resources into two primary types: **collections** and **records**. This includes providing exact hashes for records to ensure context stability.
9595
- **PatternFly API Integration**: Transitioning to the unified Library concept for standalone purposes and latest PatternFly version access.
9696
- **SQLite Persistence Layer (Opt-in)**: Leveraging **Node.js 22+** to provide an optional persistence layer for up-to-date library records and resource caching.
97-
- **Records' Seed Integration**: A "fallback" set of resource records applied to every PatternFly MCP server instance that ensures users who do not opt into SQLite persistence still receive up-to-date documentation within an average MCP server use session.
97+
- **Record Seed Integration**: A "fallback" set of resource records applied to every PatternFly MCP server instance that ensures users who do not opt into SQLite persistence still receive up-to-date documentation within an average MCP server use session.
9898

9999
#### In-planning and under review
100100
- **Skills-as-Tools (On Track)**: Expand MCP functionality with agent skills using common Markdown. This provides consumers with significant customization without modifying the PatternFly MCP server core. You can start contributing to the MCP now by adding skills through our [AI Plugin Marketplace](https://github.com/patternfly/ai-helpers).
@@ -112,7 +112,7 @@ Our roadmap focuses on expanding the server's reach and providing a more integra
112112
>
113113
> Contributions that overlap with upcoming roadmap items (such as the shift to modular plugins or dynamic API-level data) may be deferred or redirected to ensure they align with the future state of the project.
114114
>
115-
> Review our [contribution guidelines](../CONTRIBUTING.md)
115+
> Review our [contribution guidelines](../CONTRIBUTING.md).
116116
117117
#### Future state
118118

0 commit comments

Comments
 (0)