Skip to content

Commit da237dd

Browse files
authored
docs: update documentation for today's changes (#70)
1 parent 7736a98 commit da237dd

3 files changed

Lines changed: 40 additions & 10 deletions

File tree

CONTRIBUTING.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,11 @@ Enhancement suggestions are tracked as GitHub issues. When creating an enhanceme
3232
1. Fork the repo and create your branch from `main`
3333
2. If you've added code that should be tested, add tests
3434
3. Ensure your code follows the existing style
35-
4. Write a clear commit message describing your changes
35+
4. **Use a conventional commit format for your PR title** (e.g., `feat(node): add version caching`)
3636
5. Submit your pull request!
3737

38+
**Note:** We use squash merges, so your PR title becomes the commit message on main. Make sure it follows the [commit convention](docs/COMMIT_CONVENTION.md).
39+
3840
## Development Setup
3941

4042
### Prerequisites
@@ -196,7 +198,7 @@ test(migrate): add tests for package preservation
196198

197199
For detailed guidelines and examples, see [Commit Convention Guide](docs/COMMIT_CONVENTION.md).
198200

199-
**Note:** Pull requests are automatically checked for commit message compliance. Non-conforming commits will fail CI checks.
201+
**Note:** PR titles are automatically validated for conventional commit compliance. Non-conforming titles will fail CI checks. Since we use squash merges, your PR title becomes the final commit message.
200202

201203
## Adding a New Runtime Provider
202204

README.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -134,13 +134,19 @@ dtvem freeze
134134
dtvem install # Prompts for confirmation
135135
dtvem install --yes # Skip confirmation
136136

137-
# Check currently active versions
137+
# Check currently active versions (all runtimes)
138138
dtvem current
139139

140-
# List installed versions
140+
# Check active version for specific runtime
141+
dtvem current python
142+
143+
# List all installed versions (all runtimes)
144+
dtvem list
145+
146+
# List installed versions for specific runtime
141147
dtvem list python
142148

143-
# List all available versions
149+
# List all available versions for download
144150
dtvem list-all python
145151

146152
# List with filtering
@@ -297,7 +303,7 @@ This scans all installed versions and creates shims for every executable found,
297303
| `init` | Initialize dtvem (setup directories and PATH) | ✅ Complete |
298304
| `install [runtime] [version]` | Install a specific runtime version, or all from `.dtvem/runtimes.json` | ✅ Complete |
299305
| `uninstall <runtime> <version>` | Remove an installed version | ✅ Complete |
300-
| `list <runtime>` | List installed versions | ✅ Complete |
306+
| `list [runtime]` | List installed versions (all runtimes or specific) | ✅ Complete |
301307
| `list-all <runtime>` | List all available versions (with filtering) | ✅ Complete |
302308

303309
### Version Management

docs/COMMIT_CONVENTION.md

Lines changed: 26 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -70,18 +70,20 @@ The scope should be the name of the affected module or component:
7070
The subject contains a succinct description of the change:
7171

7272
- Use the imperative, present tense: "add" not "added" nor "adds"
73-
- Don't capitalize the first letter
73+
- Start with lowercase (but uppercase abbreviations like PR, API, CLI, URL are allowed)
7474
- No period (.) at the end
7575
- Maximum 72 characters
7676

7777
**Good examples:**
7878
- `fix(python): handle missing pip.exe on Windows`
7979
- `feat(cli): add --yes flag to install command`
8080
- `docs: add troubleshooting section to README`
81+
- `chore(ci): remove PR coverage comments`
82+
- `feat: add API endpoint for version lookup`
8183

8284
**Bad examples:**
83-
- `Fixed bug` (missing scope, not descriptive)
84-
- `feat(node): Added support for nvm.` (wrong tense, capitalized, period)
85+
- `Fixed bug` (missing type, not descriptive)
86+
- `feat(node): Added support for nvm.` (wrong tense, period at end)
8587
- `Update code` (missing type, not descriptive)
8688

8789
### Body (Optional)
@@ -156,9 +158,29 @@ Reverting due to Windows compatibility issues that need more investigation.
156158
Relates to #234
157159
```
158160

161+
## Pull Requests and Squash Merges
162+
163+
This project uses **squash merges** for all pull requests. This means:
164+
165+
- All commits in your PR are combined into a single commit on merge
166+
- **The PR title becomes the commit message** on the main branch
167+
- Your PR title must follow the conventional commit format
168+
169+
When creating a PR, ensure your title follows the format:
170+
```
171+
<type>(<scope>): <subject>
172+
```
173+
174+
For example:
175+
- `feat(node): add support for Node.js 22.x`
176+
- `fix(shim): handle API errors on Windows`
177+
- `chore(ci): update PR linting workflow`
178+
179+
The PR title is validated automatically - if it doesn't follow the convention, the CI check will fail.
180+
159181
## Validation
160182

161-
All commits in pull requests are automatically validated using [commitlint](https://commitlint.js.org/). If your commits don't follow this convention, the CI check will fail.
183+
Both PR titles and individual commits are automatically validated using [commitlint](https://commitlint.js.org/). If they don't follow this convention, the CI check will fail.
162184

163185
### Tips for Success
164186

0 commit comments

Comments
 (0)