Skip to content

Commit 48721b9

Browse files
committed
docs: update formatting and examples in documentation files
1 parent ca3e316 commit 48721b9

File tree

6 files changed

+20
-44
lines changed

6 files changed

+20
-44
lines changed

.github/copilot-instructions.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ Follow the [Conventional Commits](https://www.conventionalcommits.org/) specific
6767

6868
### Format
6969

70-
```
70+
```plaintext
7171
<type>(<scope>): <description>
7272
7373
[optional body]
@@ -97,12 +97,13 @@ docs(readme): update installation instructions
9797
test(client): add FileChunkManager unit tests
9898
refactor(utils): extract ID generation to utils
9999
ci: add automated testing to GitHub Actions
100+
chore(dependencies): update dependencies to latest versions
100101
```
101102

102103
### Best Practices
103104

104-
- Use present tense ("add" not "added")
105-
- Use imperative mood ("move" not "moves")
105+
- Use present tense (`add` not `added`)
106+
- Use imperative mood (`move` not `moves`)
106107
- Keep first line under 72 characters
107108
- Reference issues/PRs in footer: `Fixes #123`
108109
- Break long descriptions into body paragraphs

AGENTS.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ Follow the [Conventional Commits](https://www.conventionalcommits.org/) specific
9292

9393
### Format
9494

95-
```
95+
```plaintext
9696
<type>(<scope>): <description>
9797
9898
[optional body]
@@ -116,18 +116,19 @@ Follow the [Conventional Commits](https://www.conventionalcommits.org/) specific
116116
### Examples
117117

118118
```bash
119-
feat(client): add dark mode theme support
119+
feature(client): add dark mode theme support
120120
fix(server): resolve connection timeout issue
121121
docs(readme): update installation instructions
122122
test(client): add FileChunkManager unit tests
123123
refactor(utils): extract ID generation to utils
124124
ci: add automated testing to GitHub Actions
125+
chore(dependencies): update dependencies to latest versions
125126
```
126127

127128
### Best Practices
128129

129-
- Use present tense ("add" not "added")
130-
- Use imperative mood ("move" not "moves")
130+
- Use present tense (`add` not `added`)
131+
- Use imperative mood (`move` not `moves`)
131132
- Keep first line under 72 characters
132133
- Reference issues/PRs in footer when applicable
133134
- Break long descriptions into body paragraphs

CHANGELOG.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,11 @@ All notable changes to this project will be documented in this file.
66

77
### Added
88

9-
- Comprehensive unit tests (170 total: 13 server, 157 client)
10-
- Vitest testing framework for both client and server
11-
- Test scripts in package.json (test, test:watch, test:ui)
9+
- Comprehensive unit tests
1210
- Automated testing in GitHub Actions CI/CD pipeline
1311

1412
### Changed
1513

16-
- GitHub Actions workflow now includes build and test steps
1714
- Improved ID generation algorithm for better reliability
1815
- Refactored server code to extract testable utility functions
1916

CONTRIBUTING.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,14 +64,15 @@ npm run build
6464
## Making Changes
6565

6666
1. **Follow the project's coding standards**:
67+
6768
- Use TypeScript for type safety
6869
- Follow existing code patterns and conventions
6970
- Keep functions small and focused
7071
- Write clear, self-documenting code
7172

7273
2. **Write semantic commit messages** following [Conventional Commits](https://www.conventionalcommits.org/):
7374

74-
```
75+
```plaintext
7576
<type>(<scope>): <description>
7677
7778
[optional body]
@@ -82,6 +83,7 @@ npm run build
8283
**Types**: `feat`, `fix`, `docs`, `style`, `refactor`, `perf`, `test`, `build`, `ci`, `chore`
8384

8485
**Examples**:
86+
8587
```bash
8688
feat(client): add support for drag-and-drop file upload
8789
fix(server): resolve WebRTC connection timeout
@@ -90,11 +92,13 @@ npm run build
9092
```
9193

9294
3. **Write tests** for new features or bug fixes:
95+
9396
- Add unit tests in the appropriate test file
9497
- Ensure all tests pass before submitting
9598
- Aim for comprehensive test coverage
9699

97100
4. **Test your changes thoroughly**:
101+
98102
- Test WebRTC connections on different networks
99103
- Verify file transfers work correctly
100104
- Check UI responsiveness
@@ -111,17 +115,20 @@ npm run build
111115
2. **Open a pull request** on the original repository.
112116

113117
3. **Provide a clear description**:
118+
114119
- Explain what changes you made and why
115120
- Reference any related issues (e.g., "Fixes #123")
116121
- Include screenshots for UI changes
117122
- List any breaking changes
118123

119124
4. **Ensure CI checks pass**:
125+
120126
- All tests must pass
121127
- Code must be properly linted and formatted
122128
- Build must succeed
123129

124130
5. **Respond to review feedback**:
131+
125132
- Address reviewer comments promptly
126133
- Make requested changes
127134
- Re-request review after updates

README.md

Lines changed: 0 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -44,34 +44,6 @@ What makes EasyTransfer different? It's these features:
4444

4545
For specific deployment methods, please refer to the [Project Wiki](https://github.com/WCY-dt/EasyTransfer/wiki/Navigator).
4646

47-
## Development
48-
49-
### Client Commands (in `/client` directory)
50-
51-
```bash
52-
npm run dev # Start development server
53-
npm run build # Build for production
54-
npm run preview # Preview production build
55-
npm run lint # Run ESLint with auto-fix
56-
npm run format # Format code with Prettier
57-
npm test # Run tests
58-
npm run test:watch # Run tests in watch mode
59-
npm run test:ui # Run tests with UI
60-
```
61-
62-
### Server Commands (in `/server` directory)
63-
64-
```bash
65-
npm run dev # Build and start with nodemon
66-
npm run build # Compile TypeScript
67-
npm run start # Start production server
68-
npm run lint # Run ESLint with auto-fix
69-
npm run format # Format code with Prettier
70-
npm test # Run tests
71-
npm run test:watch # Run tests in watch mode
72-
npm run test:ui # Run tests with UI
73-
```
74-
7547
## Contributing
7648

7749
If you want to contribute code to this project, please refer to the [Contribution Guide](https://github.com/WCY-dt/EasyTransfer/blob/main/CONTRIBUTING.md).

SECURITY.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,9 @@ We release patches for security vulnerabilities in the following versions:
77
| Component | Version | Supported |
88
| --------- | ------- | ------------------ |
99
| Client | 3.4.x | :white_check_mark: |
10-
| Client | 3.3.x | :white_check_mark: |
11-
| Client | < 3.3 | :x: |
10+
| Client | < 3.4 | :x: |
1211
| Server | 3.4.x | :white_check_mark: |
13-
| Server | 3.3.x | :white_check_mark: |
14-
| Server | < 3.3 | :x: |
12+
| Server | < 3.4 | :x: |
1513

1614
## Reporting a Vulnerability
1715

0 commit comments

Comments
 (0)