Welcome to the galactic project! We’re excited to have you join our open-source community. This guide will help you set up your development environment, adhere to our coding standards, and contribute effectively.
To contribute to galactic, you should have a basic familiarity with:
- TypeScript & Node.js
- discord.js
- Git & GitHub
- Basic knowledge of clustering and sharding concepts for Discord bots is a plus
- Fork the repository on GitHub
- Clone your fork locally
- Install dependencies with
npm installoryarn - Build the project using
npm run buildoryarn build - Run tests with
npm testoryarn test(optional but encouraged) - Start developing your feature or fix on a dedicated branch
We recommend using Visual Studio Code with the official TypeScript and ESLint extensions for the best developer experience.
- Always create a new branch for your changes. Avoid committing directly to
main. - Keep pull requests focused and manageable—one feature, fix, or improvement per pull request.
- Add clear commit messages and documentation for your changes.
- Open your pull request against the main galactic repository.
- If your work is ongoing, mark the pull request as a Draft.
All pull requests undergo review by the maintainers.
After approval, your changes will be merged.
Depending on the size and complexity, reviews may take several days.
- Issue Tracker — Report bugs or request features
- Discord Server — Join our community for support and discussions
Thank you for helping make galactic better!