Skip to content

Commit fca5394

Browse files
committed
chore: Update documentation on contributing
1 parent 22c6079 commit fca5394

2 files changed

Lines changed: 7 additions & 8 deletions

File tree

.github/pull_request_template.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,6 @@ Relates to #
6969
- [ ] I have updated the documentation (README.md, CONTRIBUTING.md, etc.) if needed
7070
- [ ] My changes generate no new warnings or errors
7171
- [ ] I have checked my code works on multiple platforms (Windows, macOS, Linux) if applicable
72-
- [ ] I have updated `.claude/TODO.md` if I completed any TODO items
7372
- [ ] I have added appropriate error handling
7473
- [ ] I have followed conventional commit format in my commit messages
7574

CONTRIBUTING.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,8 @@ 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. Update the README.md TODO section if you've completed items
36-
5. Write a clear commit message describing your changes
37-
6. Submit your pull request!
35+
4. Write a clear commit message describing your changes
36+
5. Submit your pull request!
3837

3938
## Development Setup
4039

@@ -222,9 +221,10 @@ To add support for a new runtime (e.g., Ruby):
222221
```go
223222
_ "github.com/dtvem/dtvem/src/runtimes/ruby"
224223
```
225-
5. Update the shim mapping in `src/cmd/shim/main.go`
226-
6. Add shim definitions to `src/internal/shim/manager.go`
227-
7. Update README.md to reflect the new runtime support
224+
5. Implement the `Shims()` method to define which executables this runtime provides
225+
6. Implement the `ShouldReshimAfter()` method for automatic reshim detection
226+
7. Add tests using the provider contract harness
227+
8. Update README.md to reflect the new runtime support
228228

229229
## Testing Guidelines
230230

@@ -264,7 +264,7 @@ func TestNodeProvider_DetectInstalled(t *testing.T) {
264264
## Documentation
265265

266266
- Update README.md when adding new features
267-
- Mark completed TODO items in README.md
267+
- Close related GitHub Issues when completing work
268268
- Add inline comments for complex logic
269269
- Update command help text when modifying commands
270270
- Add examples for new functionality

0 commit comments

Comments
 (0)