Skip to content

Latest commit

 

History

History
294 lines (224 loc) · 12.4 KB

CONTRIBUTING.md

File metadata and controls

294 lines (224 loc) · 12.4 KB
Raw

Contributing

Table of contents

Overview

Thank you for your interest in contributing to Carbon! There are many ways to contribute, and we appreciate all of them. If you have questions, please feel free to ask on Discord or GitHub.

Everyone contributing to Carbon is expected to:

We also encourage anyone interested in contributing to check out all the information here in our contributing guide, especially the guidelines and philosophy for contributions

Ways to contribute

Help comment on proposals

If you're looking for a quick way to contribute, commenting on proposals is a way to provide proposal authors with a breadth of feedback. The "Evolution > Ideas" forum is where authors will go for early, high-level feedback. The "Evolution > Proposal reviews" forum will have more mature proposals that are nearing the decision process. For more about the difference, see the evolution process.

When giving feedback, please keep comments positive and constructive. Our goal is to use community discussion to improve proposals and assist authors.

Help contribute ideas to Carbon

If you have ideas for Carbon, we encourage you to discuss it with the community, and potentially prepare a proposal for it. Ultimately, any changes or improvements to Carbon will need to turn into a proposal and go through our evolution process.

If you do start working on a proposal, keep in mind that this requires a time investment to discuss the idea with the community, get it reviewed, and eventually implemented. A good starting point is to read through the evolution process. We encourage discussing the idea early, before even writing a proposal, and the process explains how to do that.

Help implement Carbon's design

Eventually, we will also be working toward a reference implementation of Carbon, and are very interested in folks joining in to help us with it.

Help address bugs

As Carbon's design and eventually implementation begin to take shape, we'll inevitably end up with plenty of bugs. Helping us triage, analyze, and address them is always a great way to get involved. When we have the bug tracker(s) set up for this, we'll update this section with ideas of how to find these and get started.

How to become a contributor to Carbon

Contributor License Agreements (CLAs)

We'd love to accept your documentation, pull requests, and comments! Before we can accept them, we need you to cover some legal bases.

Please fill out either the individual or corporate CLA.

  • If you are an individual contributing to spec discussions or writing original source code and you're sure you own the intellectual property, then you'll need to sign an individual CLA.
  • If you work for a company that wants to allow you to contribute your work, then you'll need to sign a corporate CLA.

Follow either of the two links above to access the appropriate CLA and instructions for how to sign and return it. Once we receive it, we'll be able to accept your documents, comments and pull requests.

NOTE: Only original content from you and other people who have signed the CLA can be accepted as Carbon contributions: this covers GitHub (including both code and discussion), Google Docs, and Discord.

Future CLA plans

Initially, Carbon is bootstrapping using Google's CLA. We are planning to create an open source foundation and transfer all Carbon-related rights to it; our goal is for the foundation setup to be similar to other open source projects, such as LLVM or Kubernetes.

Collaboration systems

We use a few systems for collaboration which contributors should be aware of.

Before using these systems, everyone must sign the CLA. They are all governed by the Code of Conduct.

Note that commenting on Google Docs and some label changes in GitHub will require some contributor access: make sure you've signed the CLA then ask for access on #getting-started on Discord.

Contribution tools

Please see our contribution tool documentation for information on setting up a git client for Carbon development, as well as helpful tooling that will ease the contribution process. For example, pre-commit is used to simplify code review.

Contribution guidelines and standards

All documents and pull requests must be consistent with the guidelines and follow the Carbon documentation and coding styles.

Guidelines and philosophy for contributions

  • For both documentation and code:

    • When the Carbon team accepts new documentation or features, to Carbon, by default they take on the maintenance burden. This means they'll weigh the benefit of each contribution must be weighed against the cost of maintaining it.
    • The appropriate style is applied.
    • The license is present in all contributions.
    • Code review is used to improve the correctness, clarity, and consistency of all contributions.
      • Please avoid rebasing PRs after receiving comments; it can break viewing of the comments in files.

  • For documentation:

    • All documentation is written for clarity and readability. Beyond fixing spelling and grammar, this also means content is worded to be accessible to a broad audience.
    • Substantive changes to Carbon follow the evolution process. Pull requests are only sent after the documentation changes have been accepted by the reviewing team.
    • Typos or other minor fixes that don't change the meaning of a document do not need formal review, and are often handled directly as a pull request.

  • For code:

    • New features should have a documented design that has been approved through the evolution process. This includes modifications to pre-existing designs.
    • Bug fixes and mechanical improvements don't need this.
    • All new features include unit tests, as they help to (a) document and validate concrete usage of the feature and its edge cases, and (b) guard against future breaking changes to lower the maintenance cost.
    • Bug fixes also generally include unit tests, because the presence of bugs usually indicates insufficient test coverage.
    • Unit tests must pass with the changes.
    • If some tests fail for unrelated reasons, we wait until they're fixed. It helps to contribute a fix!
    • Code changes should be made with API compatibility and evolvability in mind.
    • Keep in mind that code contribution guidelines are incomplete while we start work on Carbon, and may change later.

Style

Google Docs and Markdown

Changes to Carbon documentation follow the Google developer documentation style guide.

Markdown files should additionally use Prettier for formatting.

Other style points to be aware of are:

  • Whereas the Google developer documentation style guide says to use an em dash (text—text), we are using a double-hyphen with surrounding spaces (text -- text). We are doing this because we frequently read Markdown with fixed-width fonts where em dashes are not clearly visible.
  • Prefer the term "developers" when talking about people who would write Carbon code. We expect the Carbon's community to include people who think of themselves using many titles, including software developers, software engineers, systems engineers, reliability engineers, data scientists, computer scientists, programmers, and coders. We're using "developers" to succinctly cover the variety of titles.

Other files

If you're not sure what style to use, please ask on Discord or GitHub.

License

A license is required at the top of all documents and files.

Google Docs

Google Docs all use this template. It puts the license at the top of every page if printed.

Markdown

Markdown files always have at the top:

# DOC TITLE

<!--
Part of the Carbon Language project, under the Apache License v2.0 with LLVM
Exceptions. See /LICENSE for license information.
SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
-->

For example, see the top of CONTRIBUTING.md's raw content.

Other files

Every file type uses a variation on the same license text ("Apache-2.0 WITH LLVM-exception") with similar formatting. If you're not sure what text to use, please ask on Discord or GitHub.

Workflow

Carbon repositories all follow a common pull-request workflow for landing changes. It is a trunk-based development model that emphasizes small, incremental changes and preserves a simple linear history.

Acknowledgements

Carbon's Contributing guidelines are based on Tensorflow and Flutter guidelines. Many thanks to these communities for their help in providing a basis.