Repository navigation
ci #1: add coverage reporting, README badges, and issue/PR templates #2
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| --- | ||
| name: Bug report | ||
| about: Report a correctness issue or violated expectation | ||
| title: '' | ||
| labels: '' | ||
| assignees: '' | ||
|
|
||
| --- | ||
|
|
||
| **Describe the bug** | ||
| A clear and concise description of what the bug is. | ||
|
|
||
| **To Reproduce** | ||
| Steps to reproduce the behavior: | ||
| 1. Go to '...' | ||
| 2. 'cargo ...' | ||
|
|
||
| **Expected behavior** | ||
| A clear and concise description of what you expected to happen. | ||
|
|
||
| **Actual behavior** | ||
| A clear and concise description of what actually happened. Add redacted logs/screenshots if helpful; remove secrets and personal data first. | ||
|
|
||
| **Env (please complete the following information):** | ||
| - d-lmdb version [e.g., a tag such as `v0.1.0` or a commit hash] | ||
| - d-engine version it was built against [e.g., commit hash from `Cargo.lock`] | ||
| - Does the bug still exist on `main`? | ||
| - Rust toolchain: [output of `cargo version`] | ||
| - OS: [e.g. macOS 14, Ubuntu 22.04] | ||
|
|
||
| **Additional context** | ||
| Add any other context about the problem here. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| --- | ||
| name: Request for documentation | ||
| about: Suggest more doc to explain something. | ||
| title: '' | ||
| labels: documentation | ||
| assignees: '' | ||
|
|
||
| --- | ||
|
|
||
| **What kind of doc do you ask for?** | ||
| - [ ] Design/architecture (why it's built this way) | ||
| - [ ] Guide (how to do X) | ||
| - [ ] Example | ||
|
|
||
| **Describe the information you want** | ||
| A clear and concise description of what you want. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| --- | ||
| name: Feature Request | ||
| about: Propose a feature that fits d-lmdb's scope | ||
| title: "[Feature] " | ||
| labels: "enhancement" | ||
| assignees: "" | ||
| --- | ||
|
|
||
| ## ⚠️ Read First | ||
|
|
||
| d-lmdb targets **fault tolerance, not horizontal scaling** — LMDB stays | ||
| single-writer, single-node storage; d-engine only adds replication on top. | ||
| Features that turn this into a general-purpose distributed database | ||
| (sharding, multi-writer, secondary indexes, etc.) are out of scope — see | ||
| [CONTRIBUTING.md](../../CONTRIBUTING.md). | ||
|
|
||
| **Before submitting:** | ||
|
|
||
| - [ ] This fits the fault-tolerance-not-scaling scope above | ||
| - [ ] I've described a real use case, not a hypothetical one | ||
|
|
||
| --- | ||
|
|
||
| ## What problem does this solve? | ||
|
|
||
| (Be specific: what are you trying to do, and what stops you today?) | ||
|
|
||
| ## Proposed solution | ||
|
|
||
| **Your solution:** | ||
|
|
||
| **Why is this the simplest approach?** | ||
|
|
||
| ## Additional Context | ||
|
|
||
| - Similar features in other Raft/LMDB projects (if applicable) | ||
| - Your willingness to contribute code |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,69 @@ | ||
| ## What Does This PR Do? | ||
|
|
||
| (1-2 sentence summary) | ||
|
|
||
| **Type:** | ||
|
|
||
| - [ ] Bug Fix (with test) | ||
| - [ ] Feature (issue #\_\_\_ discussed first) | ||
| - [ ] Documentation | ||
| - [ ] Test/Coverage | ||
| - [ ] Performance (with benchmark) | ||
|
|
||
| --- | ||
|
|
||
| ## Why Is This Needed? | ||
|
|
||
| **For features:** Link to the issue where this was discussed: #\_\_\_ | ||
|
|
||
| **For bugs:** Describe the problem and how this fixes it | ||
|
|
||
| --- | ||
|
|
||
| ## Checklist | ||
|
|
||
| **Required:** | ||
|
|
||
| - [ ] `make check` (fmt + clippy + deny) passes | ||
| - [ ] `make test` passes | ||
| - [ ] Added tests for new code | ||
| - [ ] Commits squashed to 1-2 logical units | ||
|
|
||
| **If changing APIs:** | ||
|
|
||
| - [ ] Updated relevant docs | ||
| - [ ] Explained why complexity is justified | ||
|
|
||
| --- | ||
|
|
||
| ## Testing | ||
|
|
||
| **How tested:** | ||
|
|
||
| - Unit tests: (describe) | ||
| - Integration tests: (if applicable) | ||
| - Manual testing: (if applicable) | ||
|
|
||
| **For bug fixes:** | ||
|
|
||
| - [ ] Added test that fails without this fix | ||
|
|
||
| --- | ||
|
|
||
| ## Does This Fit d-lmdb's Scope? | ||
|
|
||
| - [ ] Stays within fault-tolerance, not scaling (no sharding/multi-writer/etc.) | ||
| - [ ] Keeps implementation simple | ||
| - [ ] Doesn't bloat the public API surface | ||
|
|
||
| --- | ||
|
|
||
| ## Reviewer Notes | ||
|
|
||
| (Optional: anything reviewers should focus on) | ||
|
|
||
| **Estimated review complexity:** | ||
|
|
||
| - [ ] Quick (< 100 lines) | ||
| - [ ] Medium (< 300 lines) | ||
| - [ ] Deep (> 300 lines) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.