Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
74 lines (50 loc) · 1.7 KB

CONTRIBUTING.md

File metadata and controls

74 lines (50 loc) · 1.7 KB
Raw

🎯 Contribute to Open Source

Thank you for helping improve this project.

📋 Code of Conduct

This project follows the Code of Conduct. By participating, you agree to respect it.

💖 Ways to Contribute

You can help by:

  • fixing bugs
  • improving documentation
  • adding tests
  • reviewing open issues
  • proposing improvements

🧬 Development

Please open pull requests against the dev branch. Pull requests opened against main are not accepted.

🔧 Local setup

  1. Clone the repository.
  2. Install Bun and install dependencies.
  3. Copy .env.example to .env.
  4. Fill in the required Discord, Unthread, PostgreSQL, and Redis values.
  5. Start working locally.
git clone https://github.com/wgtechlabs/unthread-discord-bot.git
cd unthread-discord-bot
bun install
cp .env.example .env
bun dev

✅ Before you open a pull request

Run the existing checks:

bun run lint
bun run type-check
bun run build
bun run test

Linting and formatting uses Biome. Run bun run lint to check and bun run format to auto-fix formatting.

If you change slash commands, deploy them again while testing locally:

bun run deploycommand

📖 Documentation contributions

Documentation improvements are always welcome, including:

  • README updates
  • setup clarification
  • troubleshooting improvements
  • typos and wording fixes

🐞 Reporting Bugs

  • For security issues, use the security policy.
  • For other bugs, open a GitHub issue.

💻 with ❤️ by Waren Gonzaga, WG Technology Labs, and Him 🙏