Contribute by improving b
In this document, you'll learn how you can contribute to b by improving the codebase.
Overview
b is a binary manager for developers that simplifies installation, versioning, and management of command-line tools. It is written in Go and is used to build the core functionality of b.
Binaries
Binaries are the command-line tools managed by b. Their definitions are stored as individual Go files in the pkg/binaries directory. Adding a new file to this directory is sufficient to register a new binary; no manual registration in cmd/b/main.go is needed.
├── cmd
│ └── b
│ └── # Root command where subcommands are registered
├── pkg
│ ├── binaries
│ │ └── # Binary definitions
│ ├── binary
│ │ └── # Binary management and download logic
│ ├── cli
│ │ └── # CLI subcommands
│ ├── path
│ │ └── # PATH management
│ └── state
│ └── # State management
└── test
├── e2e
│ └── # End-to-end tests
└── testutil
└── # Test utilities
How to contribute
If you’re adding a new library or contributing to the codebase, you need to fork the repository, create a new branch, and make all changes necessary in your repository. Then, once you’re done, create a PR in the b repository.
Base Branch
When you make an edit to an existing documentation page or fork the repository to make changes to the documentation, you have to create a new branch.
Documentation contributions always use main as the base branch. Make sure to also open your PR against the main branch.
Pull Request Conventions
When you create a pull request, prefix the title with fix:, feat: or docs:.
In the body of the PR, explain clearly what the PR does. If the PR solves an issue, use closing keywords with the issue number. For example, “Closes #1333”.
Testing
Feel free to add tests if you think it's necessary.
Coverage
We strive to have 100% test coverage. When you add a new library or make changes to an existing library, make sure to add tests that cover all functionality.
Linting
To lint the code, run the following command: