chore(docs): update contributing guide

This commit is contained in:
Divyam 2025-01-18 14:28:39 +00:00
parent 01d7a16900
commit 303a2b681a
2 changed files with 24 additions and 28 deletions

View file

@ -6,12 +6,23 @@ This guide will help you get started with contributing to TelDrive.
### Prerequisites ### Prerequisites
- Go (1.19 or later) - Go (1.22 or later)
- Node.js (for semver dependency)
- Git - Git
- Make - Task
- PowerShell (for Windows) or Bash (for Unix-like systems) - PowerShell (for Windows) or Bash (for Unix-like systems)
### Install Task
##### macOS/Linux (curl)
```sh
curl https://instl.vercel.app/go-task/task | bash
```
#### PowerShell/cmd.exe
```powershell
powershell -c "irm https://instl.vercel.app/go-task/task?platform=windows|iex"
```
### Initial Setup ### Initial Setup
1. Clone the repository: 1. Clone the repository:
@ -22,7 +33,7 @@ cd teldrive
2. Install dependencies: 2. Install dependencies:
```bash ```bash
make deps task deps
``` ```
## Building TelDrive ## Building TelDrive
@ -30,7 +41,7 @@ make deps
### Complete Build ### Complete Build
To build both frontend and backend: To build both frontend and backend:
```bash ```bash
make build task
``` ```
### Frontend Development ### Frontend Development
@ -38,19 +49,19 @@ The frontend is managed in a separate repository ([teldrive-ui](https://github.c
To set up the frontend: To set up the frontend:
```bash ```bash
make frontend task ui
``` ```
### Backend Development ### Backend Development
To build the backend only: To build the backend only:
```bash ```bash
make backend task server
``` ```
### Running TelDrive ### Running TelDrive
After building, run the application: After building, run the application:
```bash ```bash
make run task run
``` ```
## Feature Development ## Feature Development
@ -62,26 +73,7 @@ git checkout -b feature/your-feature-name
2. Generate API Spec: 2. Generate API Spec:
```bash ```bash
make gen task gen
```
## Version Management
We follow semantic versioning (MAJOR.MINOR.PATCH):
- For bug fixes:
```bash
make patch-version
```
- For new features:
```bash
make minor-version
```
- For breaking changes:
```bash
make major-version
``` ```
## Pull Request Guidelines ## Pull Request Guidelines

View file

@ -23,6 +23,10 @@ tasks:
cmds: cmds:
- task: ui - task: ui
- task: server - task: server
deps:
cmds:
- go mod download
- go mod tidy
ui: ui:
desc: Download UI assets desc: Download UI assets