mirror of
https://github.com/carbon-language/carbon-lang.git
synced 2026-09-24 22:02:23 +01:00
c5ddb57dd7
* Proposal for an explicit GitHub workflow. This suggests a GitHub workflow that uses pull requests, produces linear history, and both incentivizes and encourages small, incremental changes (both at the pull request and commit granularity). It tries to follow general best practices around software engineering at scale and GitHub workflows. It also tries to ensure the workflow is very well supported by tooling and automation built into GitHub. Of note, this proposal should match precisely the current enforced flow on our GitHub repositories. But we need to actually decide we like this, write up the rationale behind it, and document what we're doing. I've added an abbreviated version of the proposal as a documentation update to the contributing file. Happy to restructure or find a better home for this. I've tried to focus on the parts that contributors actually would need to care about as opposed to the things that are simply and fully enforced mechanically. My hope after this is to suggest more detailed code review guidelines. * Addressing review comments. Notably, I really was giving too much weight to multi-commit PRs which shouldn't be the common or default. I've tried to restructure everything to make it much more clear what is going on here. * Minor tweaks * Fix typo in CONTRIBUTING.md Co-authored-by: josh11b <josh11b@users.noreply.github.com> * Extract workflow description and remove redundancies. * remove tracking issue template field * Update proposals/p0029.md with reviewer suggsetion. Co-authored-by: Dmitri Gribenko <gribozavr@gmail.com> * Continue to address review feedback. * Apply suggestions from code review Co-authored-by: Jon Meow <46229924+jonmeow@users.noreply.github.com> Co-authored-by: austern <austern@google.com> * Incorporate code review feedback and begin moving toward "trunk" based terminology * Tweak the wording and make it a bit more consistent. * Update docs/project/pull_request_workflow.md Co-authored-by: Dmitri Gribenko <gribozavr@gmail.com> * Address more review comments. * Correct the rationale. * Tweak wording based on discussion in review. * Improve the rationale around the default branch to avoid overstating or misstatig things. * Apply suggestions from code review Co-authored-by: Jon Meow <46229924+jonmeow@users.noreply.github.com> * Clean up formatting and address a couple of comments on grammar from review. * Update docs/project/pull_request_workflow.md Co-authored-by: austern <austern@google.com> * Add to proposal list. Co-authored-by: josh11b <josh11b@users.noreply.github.com> Co-authored-by: Dmitri Gribenko <gribozavr@gmail.com> Co-authored-by: Jon Meow <46229924+jonmeow@users.noreply.github.com> Co-authored-by: austern <austern@google.com>
Docs
This directory contains current, accepted documentation underpinning Carbon. These documents cover all aspects of Carbon ranging from the project down to detailed designs for specific language features.
If you're trying to learn more about Carbon, we recommend starting at /README.md.