mirror of
https://github.com/elder-plinius/G0DM0D3.git
synced 2026-11-16 07:02:25 +00:00
43 lines
1.2 KiB
Markdown
43 lines
1.2 KiB
Markdown
# Contributing to G0DM0D3
|
|
|
|
Thanks for your interest in contributing! This project is licensed under AGPL-3.0.
|
|
|
|
## Getting Started
|
|
|
|
1. Fork the repo
|
|
2. Clone your fork: `git clone https://github.com/<you>/G0DM0D3.git`
|
|
3. Install dependencies: `npm install`
|
|
4. Copy `.env.example` to `.env` and add your API keys
|
|
5. Start the dev server: `npm run dev`
|
|
|
|
## Development
|
|
|
|
- **Frontend:** Next.js + React + TypeScript in `src/`
|
|
- **API proxy:** Express server in `api/server.ts`
|
|
- **HF Space build:** Standalone Express app in `HF/`
|
|
|
|
## Pull Requests
|
|
|
|
1. Create a feature branch: `git checkout -b feat/my-feature`
|
|
2. Make your changes and test locally
|
|
3. Commit with clear messages (e.g. `fix: resolve CORS on /chat endpoint`)
|
|
4. Push and open a PR against `main`
|
|
|
|
## Guidelines
|
|
|
|
- Keep PRs focused — one feature or fix per PR
|
|
- Don't commit API keys, secrets, or credentials
|
|
- Test your changes before opening a PR
|
|
- Be respectful in discussions
|
|
|
|
## Reporting Issues
|
|
|
|
Open a GitHub issue with:
|
|
- Steps to reproduce
|
|
- Expected vs actual behavior
|
|
- Browser/OS info if relevant
|
|
|
|
## License
|
|
|
|
By contributing, you agree that your contributions will be licensed under the AGPL-3.0 license.
|