Skip to content

Commit 3d9917f

Browse files
DeusDataDeusData
committed
Add community files and strengthen the contribution terms
Adds the Contributor Covenant 2.1 code of conduct (canonical text, byte-verified against upstream) and reproduction-first issue forms that ask for shareable reproductions — dummy snippets or public OSS repos — plus logs and exact commands, never proprietary code. CONTRIBUTING.md now states explicitly that a Signed-off-by line certifies the DCO in full for that contribution, with GitHub ToS inbound=outbound noted as the independent backstop. The VirusTotal badge now points at the latest release instead of a pinned historical scan. Signed-off-by: Martin Vogel <martin.vogel@datadice.io>
1 parent b129aab commit 3d9917f

6 files changed

Lines changed: 257 additions & 3 deletions

File tree

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 121 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,121 @@
1+
name: Bug report
2+
description: Something is wrong — help us reproduce it exactly.
3+
labels: ["bug"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thanks for the report! The single most valuable thing you can give us
9+
is a **reproduction we can run ourselves**.
10+
11+
**Please do not paste proprietary code or logs.** If the problem
12+
shows up on private code, reproduce it with a small dummy snippet or
13+
point us at a **public OSS repository** (e.g. zod, django, serilog)
14+
plus the file/commit where it happens — that is how we debug here.
15+
16+
- type: input
17+
id: version
18+
attributes:
19+
label: Version
20+
description: Output of `codebase-memory-mcp --version`
21+
placeholder: codebase-memory-mcp 0.8.1
22+
validations:
23+
required: true
24+
25+
- type: dropdown
26+
id: platform
27+
attributes:
28+
label: Platform
29+
options:
30+
- macOS (Apple Silicon)
31+
- macOS (Intel)
32+
- Linux (x64)
33+
- Linux (arm64)
34+
- Windows (x64)
35+
validations:
36+
required: true
37+
38+
- type: dropdown
39+
id: channel
40+
attributes:
41+
label: Install channel
42+
options:
43+
- GitHub release archive / install.sh / install.ps1
44+
- npm
45+
- PyPI
46+
- Homebrew
47+
- AUR
48+
- Scoop / Winget / Chocolatey
49+
- go install
50+
- Built from source
51+
validations:
52+
required: true
53+
54+
- type: dropdown
55+
id: variant
56+
attributes:
57+
label: Binary variant
58+
options:
59+
- standard
60+
- ui
61+
validations:
62+
required: true
63+
64+
- type: textarea
65+
id: what-happened
66+
attributes:
67+
label: What happened, and what did you expect?
68+
description: Actual vs. expected behavior, in a few sentences.
69+
validations:
70+
required: true
71+
72+
- type: textarea
73+
id: reproduction
74+
attributes:
75+
label: Reproduction
76+
description: |
77+
The exact steps so we can reproduce it ourselves:
78+
1. The code being indexed — a minimal dummy snippet pasted here, or a
79+
public repo + commit + file path (e.g. `colinhacks/zod@a1b2c3d,
80+
packages/zod/src/v4/core/parse.ts`).
81+
2. The exact command or MCP tool call, including JSON arguments
82+
(e.g. `codebase-memory-mcp cli search_graph '{"project":"...",
83+
"name_pattern":"..."}'`).
84+
3. What the output was vs. what it should have been.
85+
placeholder: |
86+
1. Code: public repo colinhacks/zod @ <commit>, file packages/...
87+
— or dummy snippet:
88+
```ts
89+
interface Model<T> { create(doc: Partial<T>): Promise<T>; }
90+
```
91+
2. Command: codebase-memory-mcp cli index_repository '{"repo_path":"/tmp/zod"}'
92+
3. Result: ... / Expected: ...
93+
validations:
94+
required: true
95+
96+
- type: textarea
97+
id: logs
98+
attributes:
99+
label: Logs
100+
description: |
101+
Relevant log output (stderr of the binary; for the UI variant also
102+
`GET /api/logs`). Will be auto-formatted as code — no backticks needed.
103+
Please check for private paths/strings before pasting.
104+
render: text
105+
106+
- type: input
107+
id: scale
108+
attributes:
109+
label: Project scale (if relevant)
110+
description: Approximate nodes/edges/files from the indexing summary
111+
placeholder: "5,656 nodes / 14,517 edges / 475 files"
112+
113+
- type: checkboxes
114+
id: confirmations
115+
attributes:
116+
label: Confirmations
117+
options:
118+
- label: I searched existing issues and this is not a duplicate.
119+
required: true
120+
- label: My reproduction uses shareable code (a dummy snippet or a public OSS repository), not proprietary code.
121+
required: true

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Security vulnerability
4+
url: https://github.com/DeusData/codebase-memory-mcp/security/advisories/new
5+
about: Please report security issues privately — never in a public issue. See SECURITY.md.

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
name: Feature request
2+
description: Propose an improvement or new capability.
3+
labels: ["enhancement"]
4+
body:
5+
- type: textarea
6+
id: problem
7+
attributes:
8+
label: What problem does this solve?
9+
description: The situation where the current behavior falls short — concrete examples beat abstractions.
10+
validations:
11+
required: true
12+
13+
- type: textarea
14+
id: proposal
15+
attributes:
16+
label: Proposed solution
17+
description: What you would like to happen. For new language/LSP support, name the public OSS repos that would make good test beds.
18+
validations:
19+
required: true
20+
21+
- type: textarea
22+
id: alternatives
23+
attributes:
24+
label: Alternatives considered
25+
description: Other approaches and why they fall short (optional).
26+
27+
- type: checkboxes
28+
id: confirmations
29+
attributes:
30+
label: Confirmations
31+
options:
32+
- label: I searched existing issues and this is not a duplicate.
33+
required: true

‎CODE_OF_CONDUCT.md‎

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
2+
# Contributor Covenant Code of Conduct
3+
4+
## Our Pledge
5+
6+
We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation.
7+
8+
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
9+
10+
## Our Standards
11+
12+
Examples of behavior that contributes to a positive environment for our community include:
13+
14+
* Demonstrating empathy and kindness toward other people
15+
* Being respectful of differing opinions, viewpoints, and experiences
16+
* Giving and gracefully accepting constructive feedback
17+
* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
18+
* Focusing on what is best not just for us as individuals, but for the overall community
19+
20+
Examples of unacceptable behavior include:
21+
22+
* The use of sexualized language or imagery, and sexual attention or advances of any kind
23+
* Trolling, insulting or derogatory comments, and personal or political attacks
24+
* Public or private harassment
25+
* Publishing others' private information, such as a physical or email address, without their explicit permission
26+
* Other conduct which could reasonably be considered inappropriate in a professional setting
27+
28+
## Enforcement Responsibilities
29+
30+
Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
31+
32+
Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
33+
34+
## Scope
35+
36+
This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
37+
38+
## Enforcement
39+
40+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at martin.vogel.tech@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
41+
42+
All community leaders are obligated to respect the privacy and security of the reporter of any incident.
43+
44+
## Enforcement Guidelines
45+
46+
Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
47+
48+
### 1. Correction
49+
50+
**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
51+
52+
**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
53+
54+
### 2. Warning
55+
56+
**Community Impact**: A violation through a single incident or series of actions.
57+
58+
**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
59+
60+
### 3. Temporary Ban
61+
62+
**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
63+
64+
**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
65+
66+
### 4. Permanent Ban
67+
68+
**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
69+
70+
**Consequence**: A permanent ban from any sort of public interaction within the community.
71+
72+
## Attribution
73+
74+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.1, available at [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
75+
76+
Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder][Mozilla CoC].
77+
78+
For answers to common questions about this code of conduct, see the FAQ at [https://www.contributor-covenant.org/faq][FAQ]. Translations are available at [https://www.contributor-covenant.org/translations][translations].
79+
80+
[homepage]: https://www.contributor-covenant.org
81+
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
82+
[Mozilla CoC]: https://github.com/mozilla/diversity
83+
[FAQ]: https://www.contributor-covenant.org/faq
84+
[translations]: https://www.contributor-covenant.org/translations
85+

‎CONTRIBUTING.md‎

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -174,8 +174,18 @@ matching the commit author.**
174174
git commit -s # adds: Signed-off-by: Your Name <you@example.com>
175175
```
176176

177-
By signing off you certify (per the [DCO](DCO)) that you wrote the change
178-
or otherwise have the right to submit it under the MIT license.
177+
**Adding a `Signed-off-by` line to a commit constitutes your certification
178+
of the [Developer Certificate of Origin 1.1](DCO) — in full, all four
179+
clauses — for that contribution.** The sign-off must match the commit's
180+
author name and email (enforced by CI). In short: you certify that you
181+
wrote the change or otherwise have the right to submit it under the MIT
182+
license, and that you understand the contribution and your sign-off are
183+
public and permanent.
184+
185+
(Independently of the DCO, submitting a contribution to this repository is
186+
also subject to GitHub's Terms of Service §D.6, under which contributions
187+
are licensed inbound = outbound — i.e., under this repository's MIT
188+
license.)
179189

180190
Enforcement is strict and automated:
181191

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
[![Platform](https://img.shields.io/badge/macOS_%7C_Linux_%7C_Windows-supported-lightgrey)](https://github.com/DeusData/codebase-memory-mcp/releases/latest)
1212
[![OpenSSF Scorecard](https://api.scorecard.dev/projects/github.com/DeusData/codebase-memory-mcp/badge)](https://scorecard.dev/viewer/?uri=github.com/DeusData/codebase-memory-mcp)
1313
[![SLSA 3](https://slsa.dev/images/gh-badge-level3.svg)](https://slsa.dev)
14-
[![VirusTotal](https://img.shields.io/badge/VirusTotal-0%2F72_engines-brightgreen?logo=virustotal)](https://www.virustotal.com/gui/file/8e12bb2d6ead7f20a6d3bf2be1e51f978c38acce810f0734f510d134b039d152/detection)
14+
[![VirusTotal](https://img.shields.io/badge/VirusTotal-scanned_every_release-brightgreen?logo=virustotal)](https://github.com/DeusData/codebase-memory-mcp/releases/latest)
1515
[![arXiv](https://img.shields.io/badge/arXiv-2603.27277-b31b1b?logo=arxiv)](https://arxiv.org/abs/2603.27277)
1616

1717
**The fastest and most efficient code intelligence engine for AI coding agents.** Full-indexes an average repository in milliseconds, the Linux kernel (28M LOC, 75K files) in 3 minutes. Answers structural queries in under 1ms. Ships as a single static binary for macOS, Linux, and Windows — download, run `install`, done.

0 commit comments

Comments
 (0)