You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/CONTRIBUTING.md
+24-47Lines changed: 24 additions & 47 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
-
# Contributing to vitest-environment-prisma-postgres
1
+
# Contributing to vitest-prisma
2
2
3
-
Thank you for considering contributing to vitest-environment-prisma-postgres! Whether you're fixing a typo, reporting a bug, or proposing a new feature, your contribution helps make database testing faster and easier for the entire Vitest and Prisma community. This is a small project maintained in limited time, and every contribution is genuinely appreciated.
3
+
Thank you for considering contributing to vitest-prisma! Whether you're fixing a typo, reporting a bug, or proposing a new feature, your contribution helps make database testing faster and easier for the entire Vitest and Prisma community. This is a small project maintained in limited time, and every contribution is genuinely appreciated.
4
4
5
5
## How You Can Contribute
6
6
@@ -31,7 +31,7 @@ When reporting a bug, please include:
31
31
- Package version
32
32
- Vitest version
33
33
- Prisma version
34
-
-PostgreSQL version
34
+
-Database adapter and version (e.g. `@prisma/adapter-pg`)
35
35
-**Error messages** or stack traces if applicable
36
36
37
37
The more details you provide, the easier it is to understand and fix the issue.
@@ -48,9 +48,11 @@ The more details you provide, the easier it is to understand and fix the issue.
# then add the upstream remote (the-kaizen-labs/vitest-prisma)
55
+
cd vitest-prisma
54
56
```
55
57
56
58
3.**Install dependencies**:
@@ -69,7 +71,7 @@ All tests must pass before submitting a pull request.
69
71
70
72
### Code Quality Checks
71
73
72
-
This project uses [Biome](https://biomejs.dev/) for linting and formatting:
74
+
This project uses [Oxlint](https://oxc.rs/docs/guide/usage/linter) for linting and[Oxfmt](https://oxc.rs/docs/guide/usage/formatter) for formatting:
73
75
74
76
```bash
75
77
pnpm run lint # Check for linting issues
@@ -104,6 +106,7 @@ For **small fixes** (typos, small bug fixes, documentation improvements), feel f
104
106
### Creating a Pull Request
105
107
106
108
1.**Create a feature branch** from `main`:
109
+
107
110
```bash
108
111
git checkout -b feat/your-feature-name
109
112
# or
@@ -119,6 +122,7 @@ For **small fixes** (typos, small bug fixes, documentation improvements), feel f
119
122
3.**Commit your changes** following our [commit message guidelines](#commit-message-guidelines)
120
123
121
124
4.**Push to your fork**:
125
+
122
126
```bash
123
127
git push origin feat/your-feature-name
124
128
```
@@ -141,52 +145,25 @@ For **small fixes** (typos, small bug fixes, documentation improvements), feel f
141
145
- Once approved, your PR will be merged using "Squash and Merge"
142
146
- Your contribution will be included in the next release with automated changelog generation
143
147
144
-
## Commit Message Guidelines
148
+
## Changesets
145
149
146
-
This project uses [Conventional Commits](https://www.conventionalcommits.org/) for automated changelog generation and semantic versioning.
150
+
This project uses [Changesets](https://github.com/changesets/changesets) for changelog generation and versioning. If your PR contains a user-facing change (a feature, fix, or breaking change), add a changeset:
147
151
148
-
### Format
149
-
150
-
```
151
-
<type>: <description>
152
+
```bash
153
+
pnpm changeset
152
154
```
153
155
154
-
### Types
156
+
Pick the appropriate semver bump (`patch` / `minor` / `major`) and write a short summary that will land in the public changelog. Commit the generated file in `.changeset/` along with your PR.
155
157
156
-
Based on the project's release configuration, use one of these types:
158
+
Internal-only changes (refactors, tests, CI tweaks) don't need a changeset.
157
159
158
-
-`feat:` - New features (appears in changelog as ✨ **New Features**)
159
-
-`fix:` - Bug fixes (appears in changelog as 🐛 **Bug Fixes**)
160
-
-`docs:` - Documentation changes (appears in changelog as 📚 **Documentation**)
161
-
-`perf:` - Performance improvements (appears in changelog as 🚀 **Performance**)
162
-
-`ci:` - CI/CD changes (appears in changelog as ⚙️ **CI**)
163
-
-`test:` - Test additions or changes (not in changelog)
164
-
-`refactor:` - Code refactoring (not in changelog)
165
-
-`chore:` - Maintenance tasks (not in changelog)
166
-
-`build:` - Build system changes (not in changelog)
167
-
168
-
### Examples
169
-
170
-
```bash
171
-
feat: add support for nested transactions
172
-
fix: prevent memory leak in transaction rollback
173
-
docs: clarify setup instructions for Testcontainers
174
-
perf: optimize transaction initialization
175
-
test: add tests foredge casesin rollback logic
176
-
refactor: simplify client creation logic
177
-
```
178
-
179
-
Include a detailed description in the commit body explaining:
180
-
- What changed
181
-
- Why it changed
182
-
- How to migrate from the old behavior
160
+
## Commit Message Guidelines
183
161
184
-
### Tips
162
+
Commit messages are not parsed for releases (Changesets owns that), but please keep them readable:
185
163
186
-
- **Keep it concise**: The description should be clear and to the point
187
-
- **Use imperative mood**: "add feature" not "added feature" or "adds feature"
188
-
- **Don't capitalize** the first letter of the description
189
-
- **No period** at the end of the description
164
+
- Use imperative mood: "add feature" not "added feature"
165
+
- Keep the summary line short and descriptive
166
+
- Add a body when the change needs context or migration notes
0 commit comments