Skip to content

Commit 74279e3

Browse files
Z-GhostshellZ-Ghostshell
committed
opensource readiness round 2 check
1 parent c2e8da1 commit 74279e3

11 files changed

Lines changed: 242 additions & 33 deletions

File tree

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
name: Bug report
2+
description: Report unexpected behavior or a crash
3+
title: "[Bug]: "
4+
labels: ["bug"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to report a bug. Please include enough detail to reproduce the issue.
10+
- type: textarea
11+
id: what-happened
12+
attributes:
13+
label: What happened?
14+
description: What did you see vs what you expected?
15+
validations:
16+
required: true
17+
- type: textarea
18+
id: repro
19+
attributes:
20+
label: How to reproduce
21+
description: Steps, config snippets, or world name if relevant.
22+
placeholder: "1. …\n2. …"
23+
validations:
24+
required: true
25+
- type: textarea
26+
id: environment
27+
attributes:
28+
label: Environment
29+
description: Ghost version or commit, OS, Docker vs host, relevant provider (if any).
30+
validations:
31+
required: false
32+
- type: textarea
33+
id: logs
34+
attributes:
35+
label: Logs / screenshots
36+
description: Redact secrets before pasting.
37+
validations:
38+
required: false

‎.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: Contribute & questions
4+
url: https://ghost.bizs.app/contribute.html
5+
about: Broader coordination and contribution info

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
name: Feature request
2+
description: Suggest an idea or improvement
3+
title: "[Feature]: "
4+
labels: ["enhancement"]
5+
body:
6+
- type: textarea
7+
id: problem
8+
attributes:
9+
label: Problem or use case
10+
description: What are you trying to achieve?
11+
validations:
12+
required: true
13+
- type: textarea
14+
id: proposal
15+
attributes:
16+
label: Proposal
17+
description: How could Ghost address this (high level)?
18+
validations:
19+
required: true
20+
- type: textarea
21+
id: alternatives
22+
attributes:
23+
label: Alternatives considered
24+
validations:
25+
required: false

‎.github/dependabot.yml‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
version: 2
2+
updates:
3+
- package-ecosystem: gomod
4+
directory: /
5+
schedule:
6+
interval: weekly
7+
8+
- package-ecosystem: npm
9+
directory: /dashboard
10+
schedule:
11+
interval: weekly

‎.github/pull_request_template.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
## Summary
2+
3+
<!-- What changed and why (1–3 sentences). -->
4+
5+
## Testing
6+
7+
<!-- How you verified this (commands, manual checks). -->
8+
9+
## Risk / rollout
10+
11+
<!-- Anything reviewers should watch for (behavior change, migrations, config). -->
12+
13+
## Linked issues
14+
15+
<!-- Fixes #123 or Refs #123 -->

‎.github/workflows/test.yml‎

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,11 @@ on:
55
branches: [main, master]
66
pull_request:
77

8+
permissions:
9+
contents: read
10+
811
jobs:
9-
unit:
12+
go:
1013
runs-on: ubuntu-latest
1114
steps:
1215
- uses: actions/checkout@v4
@@ -16,5 +19,8 @@ jobs:
1619
go-version-file: go.mod
1720
cache: true
1821

22+
- name: golangci-lint
23+
uses: golangci/golangci-lint-action@v8
24+
1925
- name: Run unit tests
20-
run: go test ./... -v -race -count=1
26+
run: go test ./... -v -race -count=1

‎.golangci.yml‎

Lines changed: 0 additions & 5 deletions
This file was deleted.

‎CODE_OF_CONDUCT.md‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our pledge
4+
5+
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.
6+
7+
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
8+
9+
## Our standards
10+
11+
Examples of behavior that contributes to a positive environment for our community include:
12+
13+
- Demonstrating empathy and kindness toward other people
14+
- Being respectful of differing opinions, viewpoints, and experiences
15+
- Giving and gracefully accepting constructive feedback
16+
- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
17+
- Focusing on what is best not just for us as individuals, but for the overall community
18+
19+
Examples of unacceptable behavior include:
20+
21+
- The use of sexualized language or imagery, and sexual attention or advances of any kind
22+
- Trolling, insulting or derogatory comments, and personal or political attacks
23+
- Public or private harassment
24+
- Publishing others’ private information, such as a physical or email address, without their explicit permission
25+
- Other conduct which could reasonably be considered inappropriate in a professional setting
26+
27+
## Enforcement responsibilities
28+
29+
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.
30+
31+
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.
32+
33+
## Scope
34+
35+
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 email address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
36+
37+
## Enforcement
38+
39+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at the contact described on [ghost.bizs.app/contribute.html](https://ghost.bizs.app/contribute.html). All complaints will be reviewed and investigated promptly and fairly.
40+
41+
All community leaders are obligated to respect the privacy and security of the reporter of any incident.
42+
43+
## Attribution
44+
45+
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 2.1, available at [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html](https://www.contributor-covenant.org/version/2/1/code_of_conduct.html).
46+
47+
For answers to common questions about this code of conduct, see [https://www.contributor-covenant.org/faq](https://www.contributor-covenant.org/faq).

‎README.md‎

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,18 @@
1-
<p align="center">
2-
<img src="https://res.bizs.app/web/ghost/icon/ghost-main.webp" width="128" height="128" alt="Ghost in the Shell" />
3-
</p>
1+
<table align="center">
2+
<tr>
3+
<td align="right" valign="middle" style="padding-right:1.5em">
4+
<span style="display:inline-block;border:1px solid;border-radius:999px;padding:0.2em 0.85em 0.35em;line-height:1">
5+
<span style="font-size:2.75em;font-weight:700">Ghost</span>
6+
</span>
7+
<br /><br />
8+
<span style="font-size:0.95em;opacity:0.85">in the shell</span>
9+
<hr align="right" width="72" style="margin:0.75em 0 0 auto;opacity:0.45" />
10+
</td>
11+
<td align="left" valign="middle" style="padding-left:1.5em">
12+
<img src="https://res.bizs.app/web/ghost/icon/ghost-main.webp" width="128" height="128" alt="Ghost in the Shell" />
13+
</td>
14+
</tr>
15+
</table>
416

517
<p align="center">
618
<strong>Many AI agents on one host</strong> — each with personality, purpose, rules, and tools. Agents think, act, observe, and remember. They coordinate through schedules, channels (including Slack), inter-agent messaging, and optional <strong>Ghost Whisper</strong> evaluation on the heartbeat path.
@@ -51,6 +63,10 @@ For more Compose variants and Make targets, see [`Makefile`](Makefile) and [`doc
5163

5264
[MIT License](LICENSE).
5365

66+
## Security
67+
68+
To report a security vulnerability, follow [`SECURITY.md`](SECURITY.md). Please do not file sensitive issues in public GitHub issues.
69+
5470
## Contributing
5571

56-
Contributions are welcome. Read [`CONTRIBUTING.md`](CONTRIBUTING.md) before opening a pull request. Questions and coordination: [Contribute](https://ghost.bizs.app/contribute.html) on the site and the contact there.
72+
Contributions are welcome. Read [`CONTRIBUTING.md`](CONTRIBUTING.md) and [`CODE_OF_CONDUCT.md`](CODE_OF_CONDUCT.md) before opening a pull request. Questions and coordination: [Contribute](https://ghost.bizs.app/contribute.html) on the site and the contact there.

‎SECURITY.md‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Security
2+
3+
## Supported versions
4+
5+
Security fixes are applied to the default branch of this repository (`main` / `master` as applicable). Use the latest release or commit when deploying.
6+
7+
## Reporting a vulnerability
8+
9+
**Please do not** open a public GitHub issue for security vulnerabilities.
10+
11+
Instead, use one of the following:
12+
13+
1. **GitHub private vulnerability reporting** — If enabled for this repository, use **Security → Report a vulnerability** on the GitHub project page.
14+
2. **Maintainer contact** — Use the contact or coordination path described on [ghost.bizs.app/contribute.html](https://ghost.bizs.app/contribute.html) for sensitive reports.
15+
16+
Include:
17+
18+
- A short description of the issue and its impact
19+
- Steps to reproduce or proof-of-concept (if safe to share)
20+
- Affected versions or commits, if known
21+
22+
We aim to acknowledge reports within a few business days and will work with you on a fix and disclosure timeline.
23+
24+
## Scope
25+
26+
In scope: this repository’s code, default configuration, and documented deployment paths. Out of scope: third-party services, misconfigured API keys in your environment, or issues in dependencies unless they require a change in this project.

0 commit comments

Comments
 (0)