mirror of
https://github.com/wu736139669/hapi.git
synced 2026-10-06 18:39:47 +00:00
79 lines
2.5 KiB
Markdown
79 lines
2.5 KiB
Markdown
# Contributing to HAPI
|
|
|
|
Thank you for your interest in contributing to HAPI! We welcome bug fixes, feature suggestions, and thoughtful contributions from the community.
|
|
|
|
## Code of Conduct
|
|
|
|
- **Be friendly and respectful** - Treat everyone with kindness and professionalism
|
|
- **Help others** - Share knowledge and assist fellow contributors
|
|
- **Give constructive feedback** - Focus on the code, not the person
|
|
- **Be patient** - Remember that everyone has different experience levels
|
|
|
|
## AI-Generated Code Policy (Vibe Coding)
|
|
|
|
If you used AI tools to generate code ("Vibe Coding"), please disclose the model in your PR description. Code is judged on merit — focused scope, tests, and the other expectations below apply equally regardless of how the code was authored.
|
|
|
|
## Pull Request Guidelines
|
|
|
|
### No Mega PRs
|
|
|
|
We do not accept oversized pull requests that introduce large features all at once. Large PRs are:
|
|
|
|
- Difficult to review thoroughly
|
|
- More likely to introduce bugs
|
|
- Harder to revert if issues arise
|
|
|
|
**If you want to add a significant feature, please open an issue first to discuss the approach.** We can help break it down into smaller, reviewable chunks.
|
|
|
|
### PR Best Practices
|
|
|
|
- Keep PRs focused on a single concern
|
|
- Write clear commit messages
|
|
- Include relevant tests if applicable
|
|
- Update documentation if needed
|
|
- Reference related issues in your PR description
|
|
|
|
## Bug Reports
|
|
|
|
Bug reports are always welcome! When reporting a bug, please include:
|
|
|
|
- A clear description of the issue
|
|
- Steps to reproduce
|
|
- Expected vs actual behavior
|
|
- Your environment (OS, Node/Bun version, etc.)
|
|
- Any relevant logs or screenshots
|
|
|
|
## Feature Requests
|
|
|
|
Have an idea to improve HAPI? Open an issue with:
|
|
|
|
- A clear description of the feature
|
|
- The problem it solves
|
|
- Any implementation ideas you have
|
|
|
|
## Getting Started
|
|
|
|
1. Fork and clone the repository
|
|
2. Install Bun 1.4.0, then install dependencies from the repo root:
|
|
```bash
|
|
bun install
|
|
```
|
|
3. Start development:
|
|
```bash
|
|
bun run dev
|
|
```
|
|
|
|
See the [README](README.md) for more build options.
|
|
|
|
From the repo root, `bun typecheck` checks CLI, Hub, Web, and Relay;
|
|
`bun run test` runs CLI/Web Vitest and Hub/Shared/Relay Bun tests. Native
|
|
toolchains and checks are documented in [iOS](ios/README.md) and
|
|
[Android](android/README.md).
|
|
|
|
For documentation changes, run `bun run --cwd docs docs:build` and check
|
|
affected links and anchors in the generated site.
|
|
|
|
## Questions?
|
|
|
|
If you have questions, feel free to open an issue. We're here to help!
|