Contributing

Contributing to Spartan Compass

We use GitHub Issues to track project tasks, bugs, and features. To contribute:

• Find an open issue that interests you and assign it to yourself.
• Create a new branch from dev and name it username/issue#, so if I was assigned issue 5 I would name it "gursheyss/issue5"
• Implement changes, test thoroughly, and commit with clear messages.
• Push your branch and open a pull request (PR) to dev.
• Fix any code that doesn't pass tests
• Request a review under by clicking the settings in the review tab
• Address feedback from code review until your PR is approved and merged.

Code Style

• Run bun run format to format the code with Prettier for consistency.
• Run bun run lint to lint code and fix any issues.
• Only add comments if you did something that's difficult to understand. Don't explain something that can be explained by reading the code
• Keep PRs focused on a single issue or feature.
• Update relevant documentation.

Database Schema Changes

If you change the database schema:

1. Make changes to the schema files.
2. Generate migrations: bun run db:generate
3. Apply migrations: bun run db:migrate
4. (Optional) Seed the database: bun run db:seed

Include the generated migration files in your PR.