docs: add CONTRIBUTING.md guide#67
Open
dashitongzhi wants to merge 1 commit into
Open
Conversation
There was a problem hiding this comment.
Pull request overview
Adds a new CONTRIBUTING.md intended to guide new contributors through setup, project orientation, coding standards, and the PR process.
Changes:
- Introduces contributor onboarding documentation (setup, structure, workflow).
- Documents suggested code style and testing steps.
- Defines a basic pull request and issue reporting process.
Comments suppressed due to low confidence (6)
CONTRIBUTING.md:15
pnpm installis referenced here, but the repo uses npm (package-lock.json) for the VitePress docs and Deno tasks for the app. Update this section to the correct install steps (e.g.,npm installfordocs/tooling, and/or note that Deno fetches deps automatically).
2. **Install dependencies**
```bash
pnpm install
**CONTRIBUTING.md:26**
* `pnpm dev` doesn’t appear to exist in this repo (package.json only defines `docs:*` scripts; the app is run via `deno task start`). Please replace this with the actual dev command(s) contributors should use.
- Run in development mode
pnpm dev
**CONTRIBUTING.md:35**
* The project structure example lists `src/bot/` (Telegram handlers), but this repository doesn’t have that directory and instead has areas like `src/controllers/`, `src/api/`, and `src/server.ts`. Please update this tree to reflect the actual layout so contributors can navigate the codebase correctly.
ai-trend-publish/
├── src/
│ ├── bot/ # Telegram bot handlers
│ ├── services/ # Content fetching and processing
│ └── utils/ # Helper functions
**CONTRIBUTING.md:50**
* `pnpm lint` is referenced here, but this repo doesn’t define a `lint` script in package.json and the main workflow uses Deno. Please update the lint guidance to the actual command(s) used here (e.g., `deno lint` / any configured Deno task).
- Code style
- Use TypeScript for all new code
- Run
pnpm lintbefore committing - Write self-documenting code
**CONTRIBUTING.md:56**
* The test instructions use `pnpm test` / `pnpm lint`, but the repo’s existing tasks are Deno-based (`deno task test`, etc.) and docs use `npm run docs:*`. Please replace these commands with the ones that actually exist so contributors can verify changes.
- Test your changes
pnpm test pnpm lint
**CONTRIBUTING.md:21**
* The `.env` setup comment mentions adding a Telegram bot token, but `.env.example` is oriented around LLM providers, Weixin config, and other services (no Telegram variables). Please update this guidance to reference the actual env vars contributors need to set (and consider linking to `ENV_CONFIGURATION.md` if that’s the canonical reference).
- Environment configuration
cp .env.example .env # Edit .env with your Telegram bot token and API keys
</details>
---
💡 <a href="/liyown/ai-trend-publish/new/main?filename=.github/instructions/*.instructions.md" class="Link--inTextBlock" target="_blank" rel="noopener noreferrer">Add Copilot custom instructions</a> for smarter, more guided reviews. <a href="https://docs.github.com/en/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot" class="Link--inTextBlock" target="_blank" rel="noopener noreferrer">Learn how to get started</a>.
Comment on lines
+7
to
+10
| 1. **Requirements** | ||
| - Node.js 18+ and pnpm | ||
| - A Telegram Bot Token (from @BotFather) | ||
| - API keys for content sources (optional) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary\n\nAdded a comprehensive CONTRIBUTING.md to help contributors get started:\n\n- Development setup instructions (Node.js, pnpm)\n- Project structure overview\n- Code style guidelines\n- PR process documentation\n\nThis improves the contributor experience for new community members.