feat: prepare repository for open-source release#4
Merged
Aadil-5122 merged 2 commits intomainfrom Apr 8, 2026
Merged
Conversation
668bee3 to
de9b9df
Compare
|
Promptless prepared a documentation update related to this change. Triggered by PR #4 in usecortex/hydradb-cli Added a "CLI Now Open Source" section to the changelog documenting the MIT license, DCO sign-off requirements, CI pipeline across Python 3.10-3.13, security policy, and issue/PR templates. Review at https://app.gopromptless.ai/suggestions/35fff9af-e109-4dd6-8fc5-f846aa05b3ee |
- Add governance files: CONTRIBUTING.md, CODE_OF_CONDUCT.md, SECURITY.md - Add GitHub infrastructure: CI workflow (lint + test matrix + DCO check), issue templates, PR template, CODEOWNERS - Add Makefile with bootstrap/lint/format/test/coverage targets - Add bootstrap script (scripts/bootstrap.sh) - Configure ruff in pyproject.toml (matching org-wide rule selection) - Add [dev] optional dependencies (ruff, pytest, pytest-cov) - Fix all ruff lint violations (unused imports, f-strings, nested with) - Apply ruff format across all source and test files - Add zip(strict=True) to output.py for safety - Expand .gitignore with IDE, OS, and tool-specific patterns Signed-off-by: Vorflux AI <noreply@vorflux.com>
de9b9df to
d22ada8
Compare
scripts/bootstrap.sh was committed without the execute bit set (mode 100644), causing `make bootstrap` to fail with 'Permission denied' since the Makefile calls it as ./scripts/bootstrap.sh. Signed-off-by: Vorflux AI <noreply@vorflux.com>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
Prepares
hydradb-clifor open-source release by adding governance files, GitHub infrastructure, CI pipeline, development tooling, and fixing all code quality issues.28 files changed (+966 / -349 lines)
1. Governance Files (new)
CONTRIBUTING.mdmake bootstrap,make test), and actual project structure. Includes DCO sign-off requirement.CODE_OF_CONDUCT.mdconduct@hydradb.com)SECURITY.mdsecurity@hydradb.com). Documents credential storage security (0600 permissions, API key masking).All governance content is original -- written specifically for HydraDB CLI.
Note:
LICENSE(MIT) already existed and was not modified. See the "License Inconsistency" note below.2. GitHub Infrastructure (new)
.github/workflows/ci.yml.github/ISSUE_TEMPLATE/bug_report.yml.github/ISSUE_TEMPLATE/feature_request.yml.github/ISSUE_TEMPLATE/config.yml.github/PULL_REQUEST_TEMPLATE.md.github/CODEOWNERS@usecortex/hydradb-maintainersfor review3. Development Tooling (new)
Makefilebootstrap,lint,format,test,coverage,clean,help. Includes venv guards.scripts/bootstrap.shpyproject.tomlchanges[dev]optional deps (ruff, pytest, pytest-cov), ruff config matching org-wide rule selection4. Code Quality Fixes
print_warningin auth.py,Optionalin config_cmd.py,Panel/Textin output.py,typerin common.py, stale imports in test_config.pywithstatements combined in test_client.py (SIM117)zip(strict=True)added in output.py for safety5. Repo Hygiene
.gitignore.ruff_cache/, IDE files, OS filesTesting
Verified Locally (all pass)
rm -rf .venv && make bootstrapruff check .ruff format --check .make lintmake testhydradb --versionhydradb-cli 0.1.0)make lintwithout venvyaml.safe_loadon ci.ymlyaml.safe_loadon all templatesNOT Verified (requires GitHub infrastructure)
pull_requestevent trigger@usecortex/hydradb-maintainersteamLicense Inconsistency Note
hydradb-benchuses Apache 2.0 whilehydradb-cliuses MIT. Apache 2.0 includes an explicit patent grant; MIT does not. If both repos are meant to be used together, having different licenses can confuse contributors. This is an org-level decision -- the LICENSE file was intentionally left unchanged in this PR.Post-Merge: GitHub Admin Actions Checklist
After merging, a repository admin should complete these steps:
main-- Settings > Branches > Add rule:lint,test)@usecortex/hydradb-maintainersteam -- Organization Settings > Teams (if not already created for hydradb-bench)cli,hydradb,ai,memory,recall,python