Skip to content

Commit

Permalink
docs: update contributing.md
Browse files Browse the repository at this point in the history
  • Loading branch information
tszhong0411 committed Feb 7, 2025
1 parent e833611 commit 58bb475
Showing 1 changed file with 5 additions and 10 deletions.
15 changes: 5 additions & 10 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,11 @@ pnpm db:migrate
7. Run the app in development mode:

```bash
pnpm dev
pnpm dev # Run all services (may take more resources to run)
# or
pnpm dev:web # Run only the web app
# or
pnpm dev:docs # Run only the documentation app
```

The services will be available at the following URLs:
Expand All @@ -96,15 +100,6 @@ The following flags can be set in the `.env.local` file to enable specific featu
- `NEXT_PUBLIC_FLAG_GUESTBOOK_NOTIFICATION`: Discord notification for guestbook.
- `NEXT_PUBLIC_FLAG_LIKE_BUTTON`: Like button for blog posts.

## Deployment

This project contains two deployable applications:

- Portfolio: Set root directory to `apps/web`
- Documentation: Set root directory to `apps/docs`

⚠️ **Important Note**: This repository is a personal project, not a template. Please do not deploy it directly to production environments.

## Conventional Commits

We follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification for commit messages. This helps us maintain a clear and organized commit history. Your commit messages should be formatted as follows:
Expand Down

0 comments on commit 58bb475

Please sign in to comment.