Skip to content

Latest commit

 

History

History
64 lines (44 loc) · 2.99 KB

CONTRIBUTING.md

File metadata and controls

64 lines (44 loc) · 2.99 KB

Contributing

If you want to contribute to this project, please stick to the following guidelines. Thank you for your work!

In all contributions, please stick to the code of conduct and be aware that your contribution will be published under the projects license.

Working with issues

Wether you want to tackle an already existing issue or bring you own one, we recommend to explain your suggested solution in the issue discussion, before beginning implementation. Issues which we think are good for newcomers are flagged as good first issue and provide a good entry into contributing to munify.

Working with branches

Github allows for easy branch creation from an issue. We recommend to do so. We require you to develop on a branch and later create a pull request which will then get reviewed and eventually merged into the main branch. Since code reviews take up a lot of time, please be patient and try to commit well documented and clearly structured code. The best documentation is always the one explaining the why.

Commit messages

We try to stick as close to the conventional commit specification as possible:

  • feat: a new feature
  • fix: a bugfix
  • style: stylistic changes to the App
  • wip: work in progress
  • format & lint: formatting and linting changes
  • typing: changes to fulfill typing requirements
  • perf: a code change that improves performance
  • docs: a documentation update
  • test: a test update
  • chore: project housekeeping
  • refactor: refactor of the code without change in functionality
  • build: changes that affect the build system or external dependencies
  • ci: changes to CI configuration files and scripts
  • revert: reverts a previous commit
  • merge: use when merging branches

If you are using the vscode extension rioukkevin.vscode-git-commit, the right settings for the convention above should be applied through the settings.json automatically.

Below are examples of well-formatted commits:

✨ feat (Frontend): implement login button and modal
branch: login

🐞 fix (General): address error in login body
branch: login

📚 docs (Backend): add examples
branch: setup

Seeding the database

To seed the database with various data/scenarios which might help you with development, please run prisma/seed/dev/seed.ts with bun after you migrated the database into the current schema. This will create a few datasets for various development scenarios. You can erase and re-seed the db as much as you want when you break things, the seed will always reset to a fixed state. Example usage commands (to run against a running database container):

// to migrate the db into the correct schema
bunx prisma migrate dev

// to reset all data in the database
bunx prisma migrate reset

// to seed the database with example data
bun prisma/seed/dev/seed.ts