@aiready/core 0.9.10 → 0.9.12
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CONTRIBUTING.md +7 -1
- package/package.json +1 -1
package/CONTRIBUTING.md
CHANGED
|
@@ -5,6 +5,7 @@ Thank you for your interest in contributing to AIReady Core! We welcome bug repo
|
|
|
5
5
|
## 🐛 Reporting Issues
|
|
6
6
|
|
|
7
7
|
Found a bug or have a feature request? [Open an issue](https://github.com/caopengau/aiready-core/issues) with:
|
|
8
|
+
|
|
8
9
|
- Clear description of the problem or feature
|
|
9
10
|
- Steps to reproduce (for bugs)
|
|
10
11
|
- Expected vs actual behavior
|
|
@@ -14,7 +15,7 @@ Found a bug or have a feature request? [Open an issue](https://github.com/caopen
|
|
|
14
15
|
|
|
15
16
|
```bash
|
|
16
17
|
# Clone your fork
|
|
17
|
-
git clone https://github.com/
|
|
18
|
+
git clone https://github.com/caopengau/aiready-core
|
|
18
19
|
cd aiready-core
|
|
19
20
|
|
|
20
21
|
# Install dependencies
|
|
@@ -33,6 +34,7 @@ pnpm lint
|
|
|
33
34
|
## 📝 Making Changes
|
|
34
35
|
|
|
35
36
|
1. **Fork the repository** and create a new branch:
|
|
37
|
+
|
|
36
38
|
```bash
|
|
37
39
|
git checkout -b fix/your-bug-fix
|
|
38
40
|
# or
|
|
@@ -46,6 +48,7 @@ pnpm lint
|
|
|
46
48
|
- Keep functions pure and focused
|
|
47
49
|
|
|
48
50
|
3. **Test your changes**:
|
|
51
|
+
|
|
49
52
|
```bash
|
|
50
53
|
pnpm build
|
|
51
54
|
pnpm test
|
|
@@ -53,12 +56,14 @@ pnpm lint
|
|
|
53
56
|
```
|
|
54
57
|
|
|
55
58
|
4. **Commit using conventional commits**:
|
|
59
|
+
|
|
56
60
|
```bash
|
|
57
61
|
git commit -m "fix: resolve token estimation edge case"
|
|
58
62
|
git commit -m "feat: add new similarity algorithm"
|
|
59
63
|
```
|
|
60
64
|
|
|
61
65
|
5. **Push and open a PR**:
|
|
66
|
+
|
|
62
67
|
```bash
|
|
63
68
|
git push origin fix/your-bug-fix
|
|
64
69
|
```
|
|
@@ -96,6 +101,7 @@ We use [Conventional Commits](https://www.conventionalcommits.org/):
|
|
|
96
101
|
## 🎯 What to Contribute
|
|
97
102
|
|
|
98
103
|
Good first contributions:
|
|
104
|
+
|
|
99
105
|
- Fix typos in documentation
|
|
100
106
|
- Add missing tests
|
|
101
107
|
- Improve error messages
|