Open
Conversation
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.
This pull request introduces several foundational improvements to the BitBuilder Cloud CLI (bbctl) project, focusing on documentation, configuration, code quality, and initial planning. The changes establish a clear project structure, add configuration and linting for both Rust and TypeScript development, and provide comprehensive guides and plans for future development.
Project Planning and Documentation:
PLAN.md.docs/api-readme.md, including instructions for schema validation, type safety, and client generation.docs/configuration-guide.md, covering all aspects of bbctl configuration, provider and credential management, and best practices.README.mdwith instructions for testing against a VyOS lab environment.Development Environment and Tooling:
.eslintrc.jsonfor TypeScript linting with recommended rules and project-specific overrides.bunfig.tomlto configure Bun for dependency management, testing, and building TypeScript code.Cargo.tomlto include theuuidcrate for networking and security features, preparing for future API and RPC additions.Developer Experience and Guidelines:
CLAUDE.mdwith more detailed build, test, and style guidelines, including project structure, code formatting, and naming conventions. [1] [2] [3] [4]These changes lay the groundwork for robust development practices, clear documentation, and a maintainable codebase as bbctl evolves.