bazelbuild / bazelbuild/bazel

Contributing.md should describe a development workflow

Open
#23,055 3 comments 0 reactions 0 assignees View on GitHub
P2 team-Documentation team-OSS type: documentation (cleanup)
Dominant language
Java
Stars
25.8k
Forks
4.6k
Avg merge
2d 20h
Merged PRs (30d)
72

Description

### Page link:

_No response_

### Problem description (include actual vs expected text, if applicable):

It'd be great if CONTRIBUTING.md would describe a sample development flow
- how to build bazel for development
- how to build a release bazel binary from your development branch
- how to build a sample project with your development copy of bazel

One could easily extend those basics with
- how to debug bazel
- how to run (a part of) the bazel test suite locally

I think a good start would be to mention `//src:bazel-bin-dev` and what it takes to use that.

### Where do you see this issue? (include link to specific section of the page, if applicable)

_No response_

### Any other information you'd like to share?

_No response_

Contributor guide

Open the contributing guide

Research direction

Start with CONTRIBUTING.md and the //src:bazel-bin-dev target mentioned in the issue. Document a sample development workflow covering development builds, release Bazel binaries, and building a sample project with the development copy; consider whether debugging and running part of the test suite fit the initial scope. Done means a newcomer can follow the documented workflow.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
build-system, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.