Skip to content

Commit 68ca6e7

Browse files
bobbyjohnstxclaude
bobbyjohnstx
and
claude
committed
chore: add CONTRIBUTING.md, SECURITY.md, and CODE_OF_CONDUCT.md
Added community files for open-source release readiness: - CONTRIBUTING.md with development setup, PR process, and coding standards - SECURITY.md with vulnerability reporting process - CODE_OF_CONDUCT.md using Contributor Covenant v2.1 Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent d034ada commit 68ca6e7

3 files changed

Lines changed: 165 additions & 0 deletions

File tree

‎CODE_OF_CONDUCT.md‎

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
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 e-mail 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 via [GitHub Issues](https://github.com/bobbyjohnstx/tinycode/issues). 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+
## Enforcement Guidelines
44+
45+
Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
46+
47+
### 1. Correction
48+
49+
**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
50+
51+
**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.
52+
53+
### 2. Warning
54+
55+
**Community Impact**: A violation through a single incident or series of actions.
56+
57+
**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.
58+
59+
### 3. Temporary Ban
60+
61+
**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
62+
63+
**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.
64+
65+
### 4. Permanent Ban
66+
67+
**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.
68+
69+
**Consequence**: A permanent ban from any sort of public interaction within the community.
70+
71+
## Attribution
72+
73+
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].
74+
75+
Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder][Mozilla CoC].
76+
77+
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].
78+
79+
[homepage]: https://www.contributor-covenant.org
80+
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
81+
[Mozilla CoC]: https://github.com/mozilla/diversity
82+
[FAQ]: https://www.contributor-covenant.org/faq
83+
[translations]: https://www.contributor-covenant.org/translations

‎CONTRIBUTING.md‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# Contributing to tinycode
2+
3+
## Development Setup
4+
5+
1. Install [Bun](https://bun.sh) (v1.3+)
6+
2. Clone the repository
7+
3. Run `bun install`
8+
4. Run `bun dev` to start in development mode
9+
10+
## Commands
11+
12+
- `bun dev` — Run TUI in development mode
13+
- `bun run lint` — Lint with oxlint
14+
- `cd packages/tinycode && bun typecheck` — Type check
15+
- `cd packages/tinycode && bun test` — Run tests
16+
17+
## Pull Request Process
18+
19+
1. Fork the repository
20+
2. Create a feature branch (`git checkout -b feature/my-feature`)
21+
3. Make your changes
22+
4. Run `bun run lint` and `cd packages/tinycode && bun test` before committing
23+
5. Use conventional commit messages: `feat:`, `fix:`, `refactor:`, `docs:`, `test:`, `chore:`
24+
6. Push and open a PR against `main`
25+
26+
## Coding Standards
27+
28+
- TypeScript with Effect framework for server-side code
29+
- SolidJS for TUI and web UI
30+
- See [AGENTS.md](AGENTS.md) for detailed coding style rules
31+
- Keep files under 800 lines
32+
- Prefer immutable patterns for shared state
33+
34+
## Adding Agents
35+
36+
Agents are markdown files in `packages/tinycode/src/agent/defaults/`. See [docs/agent-prompt-tiers.md](docs/agent-prompt-tiers.md) for the dual-tier system.
37+
38+
## Adding Skills
39+
40+
Skills are `SKILL.md` files in `packages/tinycode/src/skill/defaults/`. Each skill is a subdirectory with a SKILL.md containing YAML frontmatter.
41+
42+
## Tests
43+
44+
Run tests from a package directory, never from root:
45+
```bash
46+
cd packages/tinycode && bun test --timeout 30000
47+
```
48+
49+
## Questions?
50+
51+
Open a [GitHub Issue](https://github.com/bobbyjohnstx/tinycode/issues) for bugs or feature requests.

‎SECURITY.md‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Security Policy
2+
3+
## Reporting a Vulnerability
4+
5+
If you discover a security vulnerability, please report it responsibly:
6+
7+
1. **Do NOT** open a public GitHub issue
8+
2. Use GitHub's [private vulnerability reporting](https://github.com/bobbyjohnstx/tinycode/security/advisories/new)
9+
3. Include:
10+
- Description of the vulnerability
11+
- Steps to reproduce
12+
- Impact assessment
13+
- Suggested fix (if any)
14+
15+
## Response Timeline
16+
17+
- **Acknowledgment**: Within 48 hours
18+
- **Assessment**: Within 1 week
19+
- **Fix**: Depending on severity, typically within 2 weeks for critical issues
20+
21+
## Supported Versions
22+
23+
| Version | Supported |
24+
|---------|-----------|
25+
| 0.1.x | Yes |
26+
27+
## Security Best Practices
28+
29+
- Set `TINYCODE_SERVER_PASSWORD` when exposing the server on a network
30+
- Never commit API keys or secrets to the repository
31+
- Review MCP server configurations — they execute with your user permissions

0 commit comments

Comments
 (0)