CONTRIBUTING

When contributing to this repository, please first discuss the change you wish to make via issues.

Please note if you are working on a certain issue then make sure to stay active with development.

Git Commit, Branch, and PR Naming Conventions

When you are working with git, please be sure to follow the conventions below on your pull requests, branches, and commits:

PR: #[ISSUE ID] Title of the PR
Branch: [ISSUE ID]-title-of-the-pr (shorter)
Commit: [[ISSUE ID]] [ACTION]: what was done

Examples:

PR: #2 Add a new feature / layer
Branch: 2-add-new-layer
Commit: [2] feat: add new layer

To get started with Projectify locally, follow these steps

Clone your fork

 git clone https://github.com/<YOUR_GITHUB_ACCOUNT_NAME>/projectify.git

Navigate to the project directory
```
cd projectify
```
Create a .env file inside the project's root directory.
Copy and paste variables from .env.example into .env
Install NPM packages
```
npm i
```
Start the app dev server
```
npm run dev
```
Start the convex backend
```
npm run convex dev
```
Open your browser and visit http://localhost:3000 to see the application running.

If you're new to Github and working with open source repositories, Cody made a video a while back which walks you through the process:

If you want to work on a new feature, follow these steps.

Fork the repo
Clone your fork
Checkout a new branch
Do your work
Commit
Push your branch to your fork
Go into github UI and create a PR from your fork & branch, and merge it into upstream MAIN

You should pull in the changes that we add in daily, preferably before you checkout a new branch to do new work.

git checkout main

git pull upstream main