Skip to content

Commit be52d31

Browse files
jeremylongshoreclaude
jeremylongshore
and
claude
committed
chore: add community and security scaffolding
Add SECURITY.md (private vulnerability reporting), CODE_OF_CONDUCT.md (Contributor Covenant 2.1), CONTRIBUTING.md (dev workflow + commit convention), SUPPORT.md (help channels), PR template (checklist), and issue template config (disable blank issues, link to security and discussions). Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent fe1520f commit be52d31

6 files changed

Lines changed: 233 additions & 0 deletions

File tree

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Security Vulnerability
4+
url: https://github.com/intent-solutions-io/intent-blueprint-docs/blob/main/SECURITY.md
5+
about: Report security issues privately (do not open a public issue)
6+
- name: Questions & Discussion
7+
url: https://github.com/intent-solutions-io/intent-blueprint-docs/discussions
8+
about: Ask questions and discuss ideas

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
## Summary
2+
3+
<!-- What does this PR do? 1-3 bullet points. -->
4+
5+
## Type
6+
7+
- [ ] Bug fix
8+
- [ ] New feature
9+
- [ ] Template change
10+
- [ ] Documentation
11+
- [ ] Refactor
12+
- [ ] CI/CD
13+
14+
## Checklist
15+
16+
- [ ] `npm run lint` passes
17+
- [ ] `npm run test` passes
18+
- [ ] `make verify` passes (template count = 22, placeholders valid)
19+
- [ ] No secrets or credentials committed
20+
- [ ] Conventional commit messages used
21+
- [ ] Documentation updated (if applicable)
22+
23+
## Template Impact
24+
25+
- [ ] No template changes
26+
- [ ] Templates modified (verified with all 3 scopes)
27+
- [ ] New template added (count updated)
28+
29+
## Testing
30+
31+
<!-- How was this tested? -->

‎CODE_OF_CONDUCT.md‎

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, caste, color, religion, or sexual
10+
identity and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment:
18+
19+
* Using welcoming and inclusive language
20+
* Being respectful of differing viewpoints and experiences
21+
* Giving and gracefully accepting constructive feedback
22+
* Accepting responsibility and apologizing to those affected by our mistakes
23+
* Focusing on what is best not just for us as individuals, but for the overall community
24+
25+
Examples of unacceptable behavior:
26+
27+
* The use of sexualized language or imagery, and sexual attention or advances of any kind
28+
* Trolling, insulting or derogatory comments, and personal or political attacks
29+
* Public or private harassment
30+
* Publishing others' private information without explicit permission
31+
* Other conduct which could reasonably be considered inappropriate in a professional setting
32+
33+
## Enforcement Responsibilities
34+
35+
Community leaders are responsible for clarifying and enforcing our standards of
36+
acceptable behavior and will take appropriate and fair corrective action in
37+
response to any behavior that they deem inappropriate, threatening, offensive,
38+
or harmful.
39+
40+
## Scope
41+
42+
This Code of Conduct applies within all community spaces, and also applies when
43+
an individual is officially representing the community in public spaces.
44+
45+
## Enforcement
46+
47+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
48+
reported to the project team at **conduct@intentsolutions.io**.
49+
50+
All complaints will be reviewed and investigated promptly and fairly.
51+
52+
## Attribution
53+
54+
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org/),
55+
version 2.1, available at
56+
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html](https://www.contributor-covenant.org/version/2/1/code_of_conduct.html).

‎CONTRIBUTING.md‎

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
# Contributing to Intent Blueprint Docs
2+
3+
Thank you for your interest in contributing. This guide covers the process for submitting changes.
4+
5+
## Getting Started
6+
7+
```bash
8+
git clone https://github.com/intent-solutions-io/intent-blueprint-docs.git
9+
cd intent-blueprint-docs
10+
npm install
11+
npm run build
12+
npm run test
13+
```
14+
15+
## Development Workflow
16+
17+
1. Fork the repository
18+
2. Create a feature branch from `main`: `git checkout -b feature/my-change`
19+
3. Make your changes
20+
4. Run checks: `npm run lint && npm run test && make verify`
21+
5. Commit with conventional commits: `feat(templates): add fintech compliance section`
22+
6. Push and open a pull request
23+
24+
## Commit Convention
25+
26+
We use [Conventional Commits](https://www.conventionalcommits.org/):
27+
28+
```
29+
<type>(<scope>): <description>
30+
31+
Types: feat, fix, docs, refactor, test, chore
32+
Scopes: templates, cli, mcp, core, plugins, ci
33+
```
34+
35+
## What We Accept
36+
37+
- Bug fixes with reproduction steps
38+
- New templates or template improvements
39+
- Plugin contributions
40+
- Documentation improvements
41+
- Test coverage improvements
42+
43+
## What Needs Discussion First
44+
45+
Open an issue before submitting PRs for:
46+
47+
- New template categories
48+
- Breaking API changes
49+
- New dependencies
50+
- Architecture changes
51+
52+
## Templates
53+
54+
When modifying templates:
55+
56+
- All 22 templates must remain present (`make verify`)
57+
- Required placeholders (`{{DATE}}`, etc.) must be preserved
58+
- Follow the existing Markdown structure
59+
- Test with all three scopes: MVP, Standard, Comprehensive
60+
61+
## Code Style
62+
63+
- TypeScript with strict mode
64+
- ESLint + Prettier (enforced by CI)
65+
- Tests adjacent to source in `__tests__/`
66+
67+
## Review Process
68+
69+
1. CI must pass (lint, build, test, template verification)
70+
2. One maintainer approval required
71+
3. Squash merge to `main`
72+
73+
## License
74+
75+
By contributing, you agree that your contributions will be licensed under the Apache 2.0 License.

‎SECURITY.md‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# Security Policy
2+
3+
## Supported Versions
4+
5+
| Version | Supported |
6+
|---------|-----------|
7+
| 2.x | Yes |
8+
| < 2.0 | No |
9+
10+
## Reporting a Vulnerability
11+
12+
**Do not open a public issue for security vulnerabilities.**
13+
14+
Email **security@intentsolutions.io** with:
15+
16+
1. Description of the vulnerability
17+
2. Steps to reproduce
18+
3. Affected version(s)
19+
4. Impact assessment (if known)
20+
21+
We will acknowledge receipt within 48 hours and provide a timeline for a fix within 5 business days.
22+
23+
## Scope
24+
25+
The following are in scope:
26+
27+
- `@intentsolutions/blueprint` (CLI)
28+
- `@intentsolutions/blueprint-mcp` (MCP server)
29+
- `@intentsolutions/blueprint-core` (core engine)
30+
- Template content that could cause injection or data leakage
31+
32+
Out of scope:
33+
34+
- Third-party dependencies (report upstream)
35+
- Social engineering
36+
- Denial of service
37+
38+
## Disclosure
39+
40+
We follow coordinated disclosure. Once a fix is released, we will credit reporters (unless anonymity is requested) in the release notes.

‎SUPPORT.md‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Support
2+
3+
## Getting Help
4+
5+
- **Bugs**: [Open an issue](https://github.com/intent-solutions-io/intent-blueprint-docs/issues/new?template=bug_report.md)
6+
- **Feature requests**: [Open an issue](https://github.com/intent-solutions-io/intent-blueprint-docs/issues/new?template=feature_request.md)
7+
- **Questions**: [GitHub Discussions](https://github.com/intent-solutions-io/intent-blueprint-docs/discussions)
8+
- **Security**: See [SECURITY.md](SECURITY.md)
9+
10+
## Documentation
11+
12+
All project documentation is in [`000-docs/`](000-docs/):
13+
14+
| Doc | Title |
15+
|-----|-------|
16+
| [000](000-docs/000-DR-INDEX-standards-catalog.md) | Standards Catalog |
17+
| [003](000-docs/003-DR-SPEC-template-specification.md) | Template Specification |
18+
| [004](000-docs/004-DR-SPEC-mcp-server-integration.md) | MCP Server Integration |
19+
| [008](000-docs/008-DR-GUID-plugin-development.md) | Plugin Development |
20+
21+
## Status
22+
23+
Blueprint is in **beta**. Core features are stable, but APIs may change. See the [README](README.md#status) for current feature status.

0 commit comments

Comments
 (0)