Skip to content

Commit 5783126

Browse files
committed
chore: add project scaffolding, docs, UI components, and env examples
GitHub templates, community docs, .env.example files, setup script, home UI components, billing hook, and cache constants.
1 parent 0afc892 commit 5783126

File tree

20 files changed

+2265
-0
lines changed

20 files changed

+2265
-0
lines changed
Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
---
2+
name: Bug Report
3+
about: Report a bug to help us improve Cheatcode
4+
title: "[Bug] "
5+
labels: bug
6+
assignees: ''
7+
---
8+
9+
## Description
10+
11+
A clear and concise description of what the bug is.
12+
13+
## Steps to Reproduce
14+
15+
1. Go to '...'
16+
2. Click on '...'
17+
3. See error
18+
19+
## Expected Behavior
20+
21+
What you expected to happen.
22+
23+
## Actual Behavior
24+
25+
What actually happened. Include error messages, stack traces, or screenshots if applicable.
26+
27+
## Environment
28+
29+
- **OS:** (e.g., macOS 15.2, Ubuntu 24.04, Windows 11 + WSL2)
30+
- **Browser:** (e.g., Chrome 130, Firefox 133)
31+
- **Docker version:** (run `docker --version`)
32+
- **Node.js version:** (run `node --version`)
33+
- **Python version:** (run `python --version`)
34+
- **Deployment:** (Docker Compose / local dev / cloud)
35+
36+
## Logs
37+
38+
<details>
39+
<summary>Relevant logs</summary>
40+
41+
```
42+
Paste backend logs (`docker compose logs api`), frontend console errors, or worker logs here.
43+
```
44+
45+
</details>
46+
47+
## Additional Context
48+
49+
Any other context about the problem (screenshots, related issues, etc.).

.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: true
2+
contact_links:
3+
- name: Security Vulnerability
4+
url: mailto:founders@trycheatcode.com
5+
about: "Do not open a public issue for security vulnerabilities. Email us instead."
6+
- name: Questions & Discussions
7+
url: https://github.com/cheatcode-ai/cheatcode/discussions
8+
about: "Ask questions or start a discussion here."
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
name: Feature Request
3+
about: Suggest an idea for Cheatcode
4+
title: "[Feature] "
5+
labels: enhancement
6+
assignees: ''
7+
---
8+
9+
## Problem
10+
11+
A clear description of the problem this feature would solve. Example: "I'm frustrated when..."
12+
13+
## Proposed Solution
14+
15+
Describe the solution you'd like. Be as specific as possible about the expected behavior.
16+
17+
## Alternatives Considered
18+
19+
Any alternative solutions or features you've considered.
20+
21+
## Additional Context
22+
23+
Add any other context, mockups, screenshots, or examples from similar projects.

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
## Summary
2+
3+
Brief description of what this PR does and why.
4+
5+
## Changes
6+
7+
-
8+
9+
## Testing
10+
11+
How you tested these changes. Include steps to reproduce if relevant.
12+
13+
## Screenshots
14+
15+
If there are UI changes, include before/after screenshots.
16+
17+
## Checklist
18+
19+
- [ ] My branch is up to date with `main`
20+
- [ ] I've tested my changes locally
21+
- [ ] Linting passes (`make check`)
22+
- [ ] I've added/updated tests for new functionality
23+
- [ ] I've updated documentation if needed
24+
- [ ] My changes don't introduce security vulnerabilities

CODE_OF_CONDUCT.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Code of Conduct
2+
3+
## Our Commitment
4+
5+
We are committed to providing a welcoming, inclusive, and harassment-free experience for everyone who participates in the Cheatcode project, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, sexual identity, or sexual orientation.
6+
7+
## Expected Behavior
8+
9+
- Be respectful and considerate in all interactions
10+
- Welcome newcomers and help them get started
11+
- Give and accept constructive feedback graciously
12+
- Focus on what is best for the community and the project
13+
- Show empathy and kindness toward other community members
14+
- Use inclusive language
15+
16+
## Unacceptable Behavior
17+
18+
- Harassment, intimidation, or discrimination in any form
19+
- Trolling, insulting or derogatory comments, and personal or political attacks
20+
- Public or private harassment
21+
- Publishing others' private information without explicit permission
22+
- Sexual language, imagery, or unwelcome advances
23+
- Any conduct that would reasonably be considered inappropriate in a professional setting
24+
25+
## Scope
26+
27+
This Code of Conduct applies to all project spaces, including GitHub repositories, issues, pull requests, discussions, and any other communication channels associated with Cheatcode. It also applies when an individual is officially representing the project in public spaces.
28+
29+
## Enforcement
30+
31+
Instances of unacceptable behavior may be reported by contacting the project team at **[founders@trycheatcode.com](mailto:founders@trycheatcode.com)**. All complaints will be reviewed and investigated promptly and fairly.
32+
33+
The project team is obligated to maintain the confidentiality of the reporter. Enforcement actions may include:
34+
35+
1. **Warning** -- A private written warning with clarity about the violation and expected behavior going forward
36+
2. **Temporary Ban** -- A temporary ban from any interaction or public communication with the project
37+
3. **Permanent Ban** -- A permanent ban from any interaction or public communication with the project
38+
39+
## Attribution
40+
41+
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org/), version 2.1.

0 commit comments

Comments
 (0)