Skip to content

Commit 2e18424

Browse files
sixtdreanightsixtdreanight
committed
chore: add community health files, GitHub templates, and multi-language READMEs
- Add CODE_OF_CONDUCT.md, SECURITY.md, CONTRIBUTING.md, .editorconfig - Add issue/PR templates (.github/) - Split README into 4 languages (EN, zh-CN, zh-Hant, JA) - Add package.json metadata (description, author, repository, keywords)
1 parent 6a4a8a0 commit 2e18424

12 files changed

Lines changed: 522 additions & 40 deletions

‎.editorconfig‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
root = true
2+
3+
[*]
4+
indent_style = space
5+
indent_size = 2
6+
end_of_line = lf
7+
charset = utf-8
8+
trim_trailing_whitespace = true
9+
insert_final_newline = true
10+
11+
[*.md]
12+
trim_trailing_whitespace = false
13+
14+
[Makefile]
15+
indent_style = tab

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
name: Bug Report
3+
about: Report a bug to help us improve
4+
title: '[bug]: '
5+
labels: bug
6+
assignees: ''
7+
---
8+
9+
## Description
10+
11+
A clear and concise description of the bug.
12+
13+
## Steps to Reproduce
14+
15+
1.
16+
2.
17+
3.
18+
19+
## Expected Behavior
20+
21+
What you expected to happen.
22+
23+
## Actual Behavior
24+
25+
What actually happened, including error messages.
26+
27+
## Environment
28+
29+
- Node.js version:
30+
- OS:
31+
- Browser:
32+
33+
## Additional Context
34+
35+
Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
name: Feature Request
3+
about: Suggest an idea for this project
4+
title: '[feat]: '
5+
labels: enhancement
6+
assignees: ''
7+
---
8+
9+
## Problem Statement
10+
11+
A clear description of the problem this feature would solve.
12+
13+
## Proposed Solution
14+
15+
Describe the solution you'd like.
16+
17+
## Alternatives Considered
18+
19+
Describe any alternative solutions you've considered.
20+
21+
## Use Case
22+
23+
Describe how this feature would be used in practice.
24+
25+
## Additional Context
26+
27+
Add any other context or references here.

‎.github/pull_request_template.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
## Summary
2+
3+
<!-- Brief description of the changes -->
4+
5+
## Related Issues
6+
7+
<!-- Link to related issues: Closes #123 -->
8+
9+
## Type of Change
10+
11+
- [ ] Bug fix
12+
- [ ] New feature
13+
- [ ] New lesson
14+
- [ ] Breaking change
15+
- [ ] Documentation update
16+
- [ ] Refactor / performance improvement
17+
18+
## Checklist
19+
20+
- [ ] TypeScript compiles without errors (`npx tsc --noEmit`)
21+
- [ ] Build succeeds (`npm run build`)
22+
- [ ] New tests added for new behavior
23+
- [ ] `.env.example` updated if new env vars needed
24+
25+
## Screenshots (if applicable)
26+
27+
<!-- Add screenshots to help explain your changes -->

‎CODE_OF_CONDUCT.md‎

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
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, religion, or sexual identity
10+
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+
- Demonstrating empathy and kindness toward other people
20+
- Being respectful of differing opinions, viewpoints, and experiences
21+
- Giving and gracefully accepting constructive feedback
22+
- Accepting responsibility and apologizing to those affected by our mistakes,
23+
and learning from the experience
24+
- Focusing on what is best not just for us as individuals, but for the
25+
overall community
26+
27+
Examples of unacceptable behavior:
28+
29+
- The use of sexualized language or imagery, and sexual attention or
30+
advances of any kind
31+
- Trolling, insulting or derogatory comments, and personal or political attacks
32+
- Public or private harassment
33+
- Publishing others' private information, such as a physical or email
34+
address, without their explicit permission
35+
- Other conduct which could reasonably be considered inappropriate in a
36+
professional setting
37+
38+
## Enforcement Responsibilities
39+
40+
Community leaders are responsible for clarifying and enforcing our standards of
41+
acceptable behavior and will take appropriate and fair corrective action in
42+
response to any behavior that they deem inappropriate, threatening, offensive,
43+
or harmful.
44+
45+
Community leaders have the right and responsibility to remove, edit, or reject
46+
comments, commits, code, wiki edits, issues, and other contributions that are
47+
not aligned to this Code of Conduct, and will communicate reasons for moderation
48+
decisions when appropriate.
49+
50+
## Scope
51+
52+
This Code of Conduct applies within all community spaces, and also applies when
53+
an individual is officially representing the community in public spaces.
54+
55+
## Enforcement
56+
57+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58+
reported to the community leaders responsible for enforcement at
59+
[support@dreamnight.net.cn]. All complaints will be reviewed and investigated
60+
promptly and fairly.
61+
62+
All community leaders are obligated to respect the privacy and security of the
63+
reporter of any incident.
64+
65+
## Attribution
66+
67+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
68+
version 2.1, available at
69+
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
70+
71+
[homepage]: https://www.contributor-covenant.org
72+
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html

‎CONTRIBUTING.md‎

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
# Contributing to Vibe Coding Crash Course
2+
3+
Thanks for your interest in contributing!
4+
5+
## Getting Started
6+
7+
```bash
8+
git clone https://github.com/sixtdreanight/vibe-coding-agent.git
9+
cd vibe-coding-agent
10+
npm install
11+
cp .env.example .env.local # configure your AI provider
12+
npm run dev
13+
```
14+
15+
## Development Workflow
16+
17+
1. Fork the repo and create a branch from `main`
18+
2. Make your changes
19+
3. Run `npx tsc --noEmit` to type-check
20+
4. Run `npm run build` to verify the build
21+
5. Add tests for new functionality
22+
6. Commit using [Conventional Commits][conv] format
23+
7. Push and open a pull request
24+
25+
## Commit Convention
26+
27+
```
28+
feat: add lesson on prompt engineering
29+
fix: sanitize user input in quiz answers
30+
refactor: extract rate limiter into middleware
31+
test: add unit tests for quiz scoring
32+
docs: update SETUP_GUIDE with new provider
33+
```
34+
35+
Types: `feat` `fix` `refactor` `test` `docs` `chore` `perf` `ci`
36+
37+
## Code Style
38+
39+
- TypeScript strict mode enabled
40+
- Next.js App Router conventions
41+
- Components in `components/`, hooks in `hooks/`, lib in `lib/`
42+
- Functions under 50 lines; files under 800 lines
43+
- Use Tailwind CSS for styling
44+
45+
## Adding a Lesson
46+
47+
1. Create the lesson content in `content/lessons/`
48+
2. Add to `content/index.ts` lesson registry
49+
3. Test quiz logic with sample answers
50+
4. Update README if lesson changes course flow
51+
52+
## Pull Request Checklist
53+
54+
- [ ] TypeScript compiles without errors
55+
- [ ] Build succeeds (`npm run build`)
56+
- [ ] New tests added for new behavior
57+
- [ ] `.env.example` updated if new env vars needed
58+
- [ ] Content changes reviewed for accuracy
59+
60+
## Questions?
61+
62+
Open a [discussion](https://github.com/sixtdreanight/vibe-coding-agent/discussions).
63+
64+
[conv]: https://www.conventionalcommits.org/

‎README.ja.md‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
**言語 / Language:** [English](README.md) | [简体中文](README.zh-CN.md) | [繁體中文](README.zh-Hant.md) | [日本語](README.ja.md)
2+
3+
# Vibe Coding クラッシュコース
4+
5+
[![License](https://img.shields.io/badge/license-MIT-green)](LICENSE)
6+
[![Next.js](https://img.shields.io/badge/Next.js-16-black)](https://nextjs.org/)
7+
[![AI SDK](https://img.shields.io/badge/AI%20SDK-multi--model-purple)](https://sdk.vercel.ai/)
8+
9+
> 日本語翻訳は準備中です。完全な内容は [English](README.md) または [简体中文](README.zh-CN.md) をご参照ください。
10+
>
11+
> Japanese translation in progress. Please refer to [English](README.md) or [简体中文](README.zh-CN.md) for complete content.
12+
13+
---
14+
15+
## クイックスタート
16+
17+
```bash
18+
bash scripts/setup.sh
19+
# または手動:
20+
npm install && cp .env.example .env && npm run dev
21+
```
22+
23+
## ライセンス
24+
25+
MIT
26+
27+
---
28+
29+
<div align="center">
30+
31+
**Language / 语言 / 言語**
32+
33+
[**English**](README.md) | [**简体中文**](README.zh-CN.md) | [**繁體中文**](README.zh-Hant.md) | [**日本語**](README.ja.md)
34+
35+
</div>

0 commit comments

Comments
 (0)