Commit Graph
24 Commits
Author SHA1 Message Date
Chandler Carruth f00a8a3853 Run pre-commit scripts to update formatting and index of proposals. (#141)
These hadn't run successfully on the decision or had some stale
settings. Just cleaning up, nothing interesting changing here.
2020-08-12 03:41:25 -07:00
Sidney HummertandJon Meow ae6ba83e2e Decision for: Carbon Goals (#112)
* Add decision for proposal 51 (Goals)

* Update proposals/p0051-decision.md

Co-authored-by: Jon Meow <46229924+jonmeow@users.noreply.github.com>

Co-authored-by: Jon Meow <46229924+jonmeow@users.noreply.github.com>
2020-08-03 11:07:47 -07:00
Jon Meow d031f3cdab An incomplete, early, and in-progress overview of the language design. (#83)
Co-authored by: chandlerc

- Based on [PR 22](https://github.com/carbon-language/carbon-lang/pull/83)
- [Idea topic](https://forums.carbon-lang.dev/t/proposal-for-an-incomplete-rough-high-level-overview-ready-for-early-feedback/52)
- [RFC](https://forums.carbon-lang.dev/t/rfc-an-incomplete-early-and-in-progress-overview-of-the-language-design/73)
- [Decision announcement](https://forums.carbon-lang.dev/t/accepted-an-incomplete-early-and-in-progress-overview-of-the-language-design/110)

This proposal should be considered a starting point of the language design. It's not intended to be final; language details may change. This is intended to offer a reasonable starting point for:

- Example code.
- Conceptualizing Carbon at a high level.
- Reasonable, but not necessarily final, approaches to features in README.md.
  - If any idea is obviously bad, we can clean it up here.

This proposal is not intended to achieve:

- A whole language design.
  - This is way too much work for a single proposal; this is a skeletal framework only.
  - As we work on feature-specific designs, we may decide to use other approaches. That's fine: we only need somewhere to start.
  - The summaries in README.md may be expected to change over time.
- Feature-specific files aren't intended to be well-written or comprehensive. They are a quick jot of prior thoughts.
  - We want to avoid getting stuck on language details that we should consider
    more carefully regardless. If you're passionate about a feature, please feel
    free to start a new proposal for it.
  - Each and every aspect of the suggested overview should be subject to careful
    examination and justification before it becomes a settled plan of record.

Chandler started this with https://github.com/carbon-language/carbon-lang/pull/22. I've taken it over with the following changes:

- More of a directory hierarchy.
- Trying to thin out the main file (now README.md) to lighter summaries of features.
- Details/rationale/alternatives should be in feature-specific files.
  - Draft files are linked as references where added.

For an example of how we may proceed with feature-specific designs, see https://github.com/carbon-language/carbon-lang/pull/80. In this structure:

- docs/design/README.md mentions interoperability, with a light overview.
  - The light overview is not yet in https://github.com/carbon-language/carbon-lang/pull/80.
- docs/design/interoperability/README.md goes into more depth on interoperability, covering key points of the approach.
- Individual files in docs/design/interoperability/* go into more depth on interoperability.

Simple designs may not have a subdirectory. All current feature-specific designs do not -- they may be moved later.
2020-07-30 11:37:15 -07:00
Jon Meow be116a46c9 Adjust md tab width to work better cross-markdown-parser (#124)
We're running into issues with md handlers that expect this kind of 4-space indent. It should be cross-compatible with GH, so switch, even though it feels a little churny.

Manual edits are to:

- .prettierrc.yaml:
    - rename from .prettierrc
    - add tabWidth (primary change)
    - add trailingComma (fix vimPrettier skew)
- contribution_tools.md: Fix remarks about .prettierrc.yaml
- pre-commit-toc.js: indent, bullets
- pre-commit-proposal-list.py: indent of output

The rest is the result of `pre-commit run --all-files`

Unfortunately this'll probably depend on the change being propagated into PR branches, so I wouldn't be surprised if we see regressions for a bit. We'll also need to nudge people to update .vimrc's. Hopefully the pre-commit GH action helps catch issues.
2020-07-27 10:47:38 -07:00
Jon Meow f7b0a60cb2 Fix pre-commit issues from #51. (#115) 2020-07-20 14:36:16 -07:00
Jon Meow 00152b4ca6 Proposal for Goals (#51)
Co-authored with chandlerc

- [Draft doc](https://docs.google.com/document/d/1MJvVIDXQrhIj6hZ7NwMDbDch9XLO2VaYrGq29E57meU/edit)
- [RFC topic](https://forums.carbon-lang.dev/t/rfc-goals-for-carbon/69)
- [Decision request](https://forums.carbon-lang.dev/t/request-for-decision-goals-for-carbon/91)
- [Decision announcement](https://forums.carbon-lang.dev/t/accepted-goals-for-carbon/98)
2020-07-20 14:15:04 -07:00
Jon Meow c325ba61d4 Decision for: Linear, rebase, and pull-request GitHub workflow (#29) (#100)
- [Proposal PR](https://github.com/carbon-language/carbon-lang/pull/29)
- [RFC](https://forums.carbon-lang.dev/t/rfc-use-a-linear-pull-request-github-worflow/53)
- [Decision request](https://forums.carbon-lang.dev/t/request-for-decision-proposal-for-an-explicit-github-workflow-29/78)
- [Decision announcement](https://forums.carbon-lang.dev/t/accepted-linear-rebase-and-pull-request-github-workflow/88)
2020-07-20 14:01:57 -07:00
Jon MeowandRichard Smith af67e7452f Creates a convenience script for making new proposals. (#96)
Co-authored-by: Richard Smith <richard@metafoo.co.uk>
2020-07-10 13:37:46 -07:00
Jon Meow 4e09f03981 Consolidate towards github usernames (#105) 2020-07-08 15:32:27 -07:00
Jon Meow 53163b684e Clarify the need for a stub commit in the template. (#94) 2020-07-06 16:34:31 -07:00
Chandler Carruth 3505a258be Fix line wraps. (#102) 2020-07-03 15:35:55 -07:00
Bryce Adelstein Lelbach aka wash 15b0971eae Correct references to the default branch to use the new name, trunk. (#101) 2020-07-03 00:49:36 -07:00
c5ddb57dd7 Proposal for an explicit GitHub workflow. (#29)
* 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>
2020-06-30 23:12:39 -07:00
Jon Meow f12e86c23c Script a list of proposals in proposals/README.md (#92)
Per request from chandlerc, to make it easier to skim proposal titles outside the website.

Also fix the title of markdown-toc.
2020-06-29 15:42:26 -07:00
Jon Meow 65cfd73b78 Enable codespell pre-commit (#90)
This catches some common spelling errors, but is *not* an exhaustive spell-checker. The only false positive is "rouge" in Gemfile.lock, which is why I'm excluding that file.

True positives are in the change, and it does catch the "langauge" typo I keep making, which zygoloid fixed for me in a few spots. False negatives are:

- virmc
- Announcemented
- propsal

For comparison:

- cspell (https://www.npmjs.com/package/cspell) is too aggressive and has a small dictionary
  - Caught the false negatives, but many false positives, including 'LLVM', 'roadmap', 'Carruth'
- https://github.com/lorenzwalthert/precommit has a spellcheck, but config looks ruby-specific
2020-06-25 08:37:03 -07:00
Jon Meow 574da45a6b Remove sharing message, it's not particular to proposals
This sentence feels like a hold-over from the Google Doc, which still feels useful in that context. Especially because it's so easy to copy/share Docs outside the shared drive. However, for things going to GitHub, it seems like we should either have it everywhere or nowhere, and it doesn't feel helpful enough to have in every file.

My feeling would be different about a notice on the website -- that could be done centrally for all pages, and may be more useful. However, I haven't bothered there because we restrict access to docs, and I think the login flow should make it clearer that a lack of re-sharing is the intent.
2020-06-17 09:20:22 -07:00
Jon Meow 3a80cf363e Minor formatting fixes (#78) 2020-06-17 09:18:17 -07:00
Jon Meow 4a07b436d9 Decision for proposal timelines. (#43)
Decision for https://github.com/carbon-language/carbon-lang/pull/74:
"Proposal to change comment/decision timelines"
2020-06-16 11:12:21 -07:00
sidney13andJon Meow 61e57af028 Proposal to change comment/decision timelines (#74)
* Proposal timeline proposal

As this proposal was started and approved before the PR-based process was in place, this PR will be used to put the old proposal Doc that was approved into Markdown.

* Update p00xx.md

* Rename the proposal file to match the PR

Also update the reference inside the file.

* Update proposals/p0074.md

Co-authored-by: Jon Meow <46229924+jonmeow@users.noreply.github.com>

* Update proposals/p0074.md

Co-authored-by: Jon Meow <46229924+jonmeow@users.noreply.github.com>

Co-authored-by: Jon Meow <46229924+jonmeow@users.noreply.github.com>
2020-06-16 10:21:16 -07:00
sidney13andJon Meow 293b428eb0 Create p0044-decision.md (#47)
* Create p0044-decision.md

Document the approval and rationale for the "Carbon: Proposal Tracking" proposal.

* Fix typo

Co-authored-by: Jon Meow <46229924+jonmeow@users.noreply.github.com>

* Format using Prettier

* Punctuation/typo fixes

Co-authored-by: Jon Meow <46229924+jonmeow@users.noreply.github.com>
2020-06-16 10:19:15 -07:00
Jon MeowandChandler Carruth f1e4323fda Set up pre-commit (#73)
Added here:

- .pre-commit-config.yaml
- docs/project/contribution_tools.md
- src/scripts/pre-commit-toc.js
- CONTRIBUTING.md
- proposals/* (just to switch TOC formats)

The rest consists of auto-generated fixes.

The switch from doctoc to markdown-toc is because doctoc wants to put a TOC in every file, whereas markdown-toc only does it if you have an insertion point.

Co-authored-by: Chandler Carruth <chandlerc@gmail.com>
2020-06-16 09:09:10 -07:00
Jon Meow b7e80bf233 Remove prefix 'Carbon:' from page titles. (#54)
* Also retitle src/README.md
2020-06-04 13:34:45 -07:00
Jon Meow 18022dffc6 Changes for proposal tracking. (#45)
With edits from Chandler Carruth <chandlerc@gmail.com>
2020-06-04 08:36:46 -07:00
Jon Meow ccebb66179 Carbon: Proposal tracking (#44)
A cleaned-up version of the original proposal doc, with some minor link and example fixes. Decisions for open questions are also now noted.
2020-06-03 08:40:19 -07:00