Repository navigation
ci: add CI workflow checking Markdown formatting - #16
Merged
Merged
Conversation
Add remark based formatting and linting via `npm run all`. Issue and pull request templates are ignored as they must stay byte-exact. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Verify Markdown formatting on push and pull request. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
There was a problem hiding this comment.
🟡 Changes recommended
The CI formatting check can pass while committed Markdown remains unformatted because it fails on warnings but does not detect formatting changes to tracked files.
1 open issue
What changed in this PR
This PR adds Markdown formatting CI to the organization’s shared community-resource repository and normalizes existing documentation.
Changes:
- Adds a Node.js 24 workflow running
npm ciandnpm run all. - Configures Remark with the bpmn-io preset and excludes issue and pull request templates.
- Applies consistent Markdown formatting across existing docs.
| File | Description |
|---|---|
| SECURITY.md | Normalizes whitespace and email-link formatting. |
| README.md | Cleans up spacing and the final newline. |
| profile/README.md | Removes trailing whitespace and extra spacing. |
| package.json | Adds Remark dependencies, configuration, and scripts. |
| AGENTS.md | Standardizes lists, emphasis, and shell code fences. |
| .remarkignore | Excludes issue and pull request templates from formatting. |
| .gitignore | Ignores installed Node.js dependencies. |
| .github/workflows/CI.yml | Adds the Node.js 24 Markdown CI workflow. |
| .github/CONTRIBUTING.md | Normalizes formatting and corrects table-of-contents text. |
| .github/CODE_OF_CONDUCT.md | Normalizes emphasis, quotes, and spacing. |
Review effort: Balanced
Co-authored-by: AlekseyManetov <14283670+AlekseyManetov@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.

Proposed Changes
Add a CI workflow that checks the Markdown formatting of this repository, modelled on
bpmn-io/internal-docs(Node 24 only,npm ci,npm run all). Unlikeinternal-docs, it only checks and does not auto-commit formatting changes. The existing docs are formatted once via a separatestyle: format docscommit, and issue and pull request templates are excluded via.remarkignoreto keep them byte-exact.Steps to try out: see the CI run on this PR.
Checklist
Ensure you provide everything we need to review your contribution:
Closes {LINK_TO_ISSUE}orRelated to {LINK_TO_ISSUE}@bpmn-io/srtool🤖 Generated with Claude Code