docs: align contributor guidance with project

This commit is contained in:
bincxz committed 2026-06-30 00:55:00 +08:00
1 parent 2fcda46801
commit 109c8075c2
4 files changed
+33 -18

No files matched your search

+8 -7
View File
@@ -11,17 +11,16 @@
- [ ] Build / CI change
- [ ] Other (please describe):
## Related Issue
## Related Issue (optional)
Closes #<!-- issue number, if applicable -->
N/A
<!-- If this PR has a related issue, replace N/A with "Closes #123" or "Related to #123". -->
## Changes Made
<!-- List the key changes in this PR. -->
-
-
## Screenshots / Demo
<!-- If this PR affects UI or behavior, include screenshots or a short description. -->
@@ -30,10 +29,12 @@ Closes #<!-- issue number, if applicable -->
- [ ] I have tested these changes locally (`npm run dev`)
- [ ] Linting passes (`npm run lint`)
- [ ] No new console errors or warnings
- [ ] Tests pass (`npm test`)
- [ ] Generated capability tool specs are updated when applicable (`npm run generate:capability-tools`)
- [ ] No new console errors or warnings, if this affects app behavior
## Checklist
- [ ] My code follows the conventions in [agents.md](../agents.md)
- [ ] My code follows the existing project style
- [ ] I have added or updated relevant documentation
- [ ] I have not introduced any breaking changes (or I have described them above)
+1
View File
@@ -16,6 +16,7 @@ If you discover a security vulnerability in Netcatty, **please do not open a pub
Instead, report it privately via one of the following methods:
- **GitHub Private Vulnerability Reporting**: Use the [Security tab](https://github.com/binaricat/Netcatty/security/advisories/new) to submit a private advisory.
- **Email**: Send details to support@netcatty.com.
- **GitHub Issues** (for non-sensitive security concerns only): https://github.com/binaricat/Netcatty/issues
Please include the following details in your report:
+3 -2
View File
@@ -59,8 +59,9 @@ representative at an online or offline event.
## Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
https://github.com/binaricat/Netcatty/issues.
reported privately to the community leaders responsible for enforcement at
support@netcatty.com. Please do not report Code of Conduct incidents through
public GitHub issues.
All complaints will be reviewed and investigated promptly and fairly.
All community leaders are obligated to respect the privacy and security of the
+21 -9
View File
@@ -17,7 +17,7 @@ This project follows the [Contributor Covenant Code of Conduct](./CODE_OF_CONDUC
## Development Setup
**Prerequisites:** Node.js 18+ and npm.
**Prerequisites:** Node.js 22+ and npm.
```bash
# Clone the repository
@@ -25,7 +25,7 @@ git clone https://github.com/binaricat/Netcatty.git
cd Netcatty
# Install dependencies
npm install
npm ci
# Start in development mode (Vite + Electron)
npm run dev
@@ -37,14 +37,15 @@ npm run dev
npm run build # Build for production
npm run pack # Package for current platform
npm run pack:mac # macOS (DMG + ZIP)
npm run pack:win # Windows (NSIS installer)
npm run pack:linux # Linux (AppImage + DEB + RPM)
npm run pack:win # Windows (NSIS, portable, ZIP)
npm run pack:linux # Linux (AppImage, DEB, RPM, pacman)
```
## Linting
## Linting and Tests
```bash
npm run lint # Run ESLint
npm test # Run the test suite
```
## Pull Request Process
@@ -54,13 +55,16 @@ npm run lint # Run ESLint
```bash
git checkout -b feature/your-feature-name
```
3. Make your changes, following the coding conventions in [agents.md](./agents.md).
3. Make your changes, following the existing project style.
4. Commit with a clear message:
```bash
git commit -m 'feat: add amazing feature'
```
5. Push the branch and open a Pull Request against `main`.
6. Ensure all CI checks pass before requesting review.
6. Run `npm run lint` and `npm test` before requesting review.
7. If you changed the capability catalog, run `npm run generate:capability-tools`
and commit any generated updates.
8. Ensure all CI checks pass before requesting review.
## Commit Message Convention
@@ -72,9 +76,17 @@ We recommend following [Conventional Commits](https://www.conventionalcommits.or
- `refactor:` — code change without feature or fix
- `chore:` — build process or tooling changes
## Architecture & Coding Conventions
## Architecture & Coding Guidelines
Refer to [agents.md](./agents.md) for an overview of the project architecture, module responsibilities, and coding guidelines.
Netcatty is organized around three layers:
- Domain logic in `domain/`
- Application state in `application/state/`
- UI components in `components/`
Keep side effects in application or infrastructure code, avoid direct
`localStorage` or network calls from components, and update relevant
documentation when behavior changes.
## License