-
Notifications
You must be signed in to change notification settings - Fork 300
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fix: take correct size in encrypted streams
- Loading branch information
1 parent
7fa4a38
commit 381ea31
Showing
4 changed files
with
112 additions
and
19 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,102 @@ | ||
# Contributing to TelDrive | ||
|
||
This guide will help you get started with contributing to TelDrive. | ||
|
||
## Development Setup | ||
|
||
### Prerequisites | ||
|
||
- Go (1.19 or later) | ||
- Node.js (for semver dependency) | ||
- Git | ||
- Make | ||
- PowerShell (for Windows) or Bash (for Unix-like systems) | ||
|
||
### Initial Setup | ||
|
||
1. Clone the repository: | ||
```bash | ||
git clone https://github.com/tgdrive/teldrive.git | ||
cd teldrive | ||
``` | ||
|
||
2. Install dependencies: | ||
```bash | ||
make deps | ||
``` | ||
|
||
## Building TelDrive | ||
|
||
### Complete Build | ||
To build both frontend and backend: | ||
```bash | ||
make build | ||
``` | ||
|
||
### Frontend Development | ||
The frontend is managed in a separate repository ([teldrive-ui](https://github.com/tgdrive/teldrive-ui)). The main repository pulls the latest frontend release during build. | ||
|
||
To set up the frontend: | ||
```bash | ||
make frontend | ||
``` | ||
|
||
### Backend Development | ||
To build the backend only: | ||
```bash | ||
make backend | ||
``` | ||
|
||
### Running TelDrive | ||
After building, run the application: | ||
```bash | ||
make run | ||
``` | ||
|
||
## Feature Development | ||
|
||
1. Create a new branch for your feature: | ||
```bash | ||
git checkout -b feature/your-feature-name | ||
``` | ||
|
||
2. Generate API Spec: | ||
```bash | ||
make 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 | ||
|
||
1. **Branch Naming**: | ||
- `feature/` for new features | ||
- `fix/` for bug fixes | ||
- `docs/` for documentation changes | ||
- `refactor/` for code refactoring | ||
|
||
2. **Commit Messages**: | ||
- Use clear, descriptive commit messages | ||
- Reference issues when applicable | ||
|
||
3. **Pull Request Description**: | ||
- Describe the changes made | ||
- Include any relevant issue numbers | ||
- List any breaking changes |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters