feat/copilot instructions

This commit is contained in:
Enno Gelhaus 2025-07-17 17:41:31 +02:00 committed by GitHub
parent e1257b95fc
commit 13a0d1dad4
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 59 additions and 0 deletions

59
.github/.github/copilot-instructions.md vendored Normal file
View File

@ -0,0 +1,59 @@
Postiz is an all-in-one Social Media Scheduler.
# Instructions
## Comments
Write meaningful comments where necessary, especially for complex logic.
## Testing
If you try to code something for "Postiz", make sure to check your code with these instructions:
1. Install NodeJS 20.17.0
2. Install pNPM 8
3. Install Dependencies: "pnpm install"
4. Build it: "pnpm run build"
## "Commit"'s
Use conventional commits (feat:, fix:, chore: etc.) for commit messages.
---
# Overview
Make sure to use any information that you need here:
## Documentation
The Documentation is available under https://docs.postiz.com/
Developer Documentation is available under https://docs.postiz.com/developer-guide
## Tech Stack
- NX (Monorepo)
- NextJS (React)
- NestJS
- Prisma (Default to PostgreSQL)
- Redis (BullMQ)
- Resend (email notifications)
## License
This repository's source code is available under the [AGPL-3.0 license](LICENSE).
## Features
- Schedule all your social media posts (many AI features)
- Measure your work with analytics.
- Collaborate with other team members to exchange or buy posts.
- Invite your team members to collaborate, comment, and schedule posts.
- At the moment there is no difference between the hosted version to the self-hosted version
---
# PR and Code Review Etiquette
Expand on the PR expectations section:
```markdown
## Pull Request Expectations
When submitting a PR:
- Write a clear description of what the PR does and *why* the change was made.
- Link any related issues using `Closes #<issue-number>` syntax.
- Include screenshots/GIFs if the PR affects the UI.
- Add tests if new functionality is introduced.
- Make sure the PR passes CI and all tests before requesting review.