@aiready/core 0.1.1 โ 0.1.2
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 +110 -0
- package/package.json +3 -2
package/CONTRIBUTING.md
ADDED
|
@@ -0,0 +1,110 @@
|
|
|
1
|
+
# Contributing to @aiready/core
|
|
2
|
+
|
|
3
|
+
Thank you for your interest in contributing to AIReady Core! We welcome bug reports, feature requests, and code contributions.
|
|
4
|
+
|
|
5
|
+
## ๐ Reporting Issues
|
|
6
|
+
|
|
7
|
+
Found a bug or have a feature request? [Open an issue](https://github.com/caopengau/aiready-core/issues) with:
|
|
8
|
+
- Clear description of the problem or feature
|
|
9
|
+
- Steps to reproduce (for bugs)
|
|
10
|
+
- Expected vs actual behavior
|
|
11
|
+
- Your environment (Node version, OS)
|
|
12
|
+
|
|
13
|
+
## ๐ง Development Setup
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
# Clone your fork
|
|
17
|
+
git clone https://github.com/YOUR_USERNAME/aiready-core
|
|
18
|
+
cd aiready-core
|
|
19
|
+
|
|
20
|
+
# Install dependencies
|
|
21
|
+
pnpm install
|
|
22
|
+
|
|
23
|
+
# Build
|
|
24
|
+
pnpm build
|
|
25
|
+
|
|
26
|
+
# Run tests
|
|
27
|
+
pnpm test
|
|
28
|
+
|
|
29
|
+
# Run linter
|
|
30
|
+
pnpm lint
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
## ๐ Making Changes
|
|
34
|
+
|
|
35
|
+
1. **Fork the repository** and create a new branch:
|
|
36
|
+
```bash
|
|
37
|
+
git checkout -b fix/your-bug-fix
|
|
38
|
+
# or
|
|
39
|
+
git checkout -b feat/your-new-feature
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
2. **Make your changes** following our code style:
|
|
43
|
+
- Use TypeScript strict mode
|
|
44
|
+
- Add JSDoc comments for public APIs
|
|
45
|
+
- Write tests for new functionality
|
|
46
|
+
- Keep functions pure and focused
|
|
47
|
+
|
|
48
|
+
3. **Test your changes**:
|
|
49
|
+
```bash
|
|
50
|
+
pnpm build
|
|
51
|
+
pnpm test
|
|
52
|
+
pnpm lint
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
4. **Commit using conventional commits**:
|
|
56
|
+
```bash
|
|
57
|
+
git commit -m "fix: resolve token estimation edge case"
|
|
58
|
+
git commit -m "feat: add new similarity algorithm"
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
5. **Push and open a PR**:
|
|
62
|
+
```bash
|
|
63
|
+
git push origin fix/your-bug-fix
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
## ๐ Commit Convention
|
|
67
|
+
|
|
68
|
+
We use [Conventional Commits](https://www.conventionalcommits.org/):
|
|
69
|
+
|
|
70
|
+
- `feat:` - New feature
|
|
71
|
+
- `fix:` - Bug fix
|
|
72
|
+
- `docs:` - Documentation changes
|
|
73
|
+
- `chore:` - Maintenance tasks
|
|
74
|
+
- `refactor:` - Code refactoring
|
|
75
|
+
- `test:` - Test updates
|
|
76
|
+
|
|
77
|
+
## ๐งช Testing Guidelines
|
|
78
|
+
|
|
79
|
+
- Add tests for new functions in `src/__tests__/`
|
|
80
|
+
- Ensure all tests pass: `pnpm test`
|
|
81
|
+
- Aim for >80% code coverage
|
|
82
|
+
|
|
83
|
+
## ๐ Documentation
|
|
84
|
+
|
|
85
|
+
- Update README.md if adding new public APIs
|
|
86
|
+
- Add JSDoc comments for exported functions
|
|
87
|
+
- Include usage examples for new features
|
|
88
|
+
|
|
89
|
+
## ๐ Code Review
|
|
90
|
+
|
|
91
|
+
- Automated checks must pass (build, tests, lint)
|
|
92
|
+
- Maintainers will review within 2 business days
|
|
93
|
+
- Address feedback and update your PR
|
|
94
|
+
- Once approved, we'll merge and publish
|
|
95
|
+
|
|
96
|
+
## ๐ฏ What to Contribute
|
|
97
|
+
|
|
98
|
+
Good first contributions:
|
|
99
|
+
- Fix typos in documentation
|
|
100
|
+
- Add missing tests
|
|
101
|
+
- Improve error messages
|
|
102
|
+
- Optimize existing utilities
|
|
103
|
+
|
|
104
|
+
## โ Questions?
|
|
105
|
+
|
|
106
|
+
Open an issue or reach out to the maintainers. We're here to help!
|
|
107
|
+
|
|
108
|
+
---
|
|
109
|
+
|
|
110
|
+
**Thank you for contributing!** ๐
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aiready/core",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.2",
|
|
4
4
|
"description": "Shared utilities for AIReady analysis tools",
|
|
5
5
|
"main": "./dist/index.js",
|
|
6
6
|
"module": "./dist/index.mjs",
|
|
@@ -30,7 +30,8 @@
|
|
|
30
30
|
"files": [
|
|
31
31
|
"dist",
|
|
32
32
|
"README.md",
|
|
33
|
-
"LICENSE"
|
|
33
|
+
"LICENSE",
|
|
34
|
+
"CONTRIBUTING.md"
|
|
34
35
|
],
|
|
35
36
|
"devDependencies": {
|
|
36
37
|
"tsup": "^8.3.5",
|