|
|
@@ -22,9 +22,9 @@ 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](#guidelines-and-philosophy-for-contributions)
|
|
|
|
|
|
-# Ways to contribute
|
|
|
+## Ways to contribute
|
|
|
|
|
|
-## Help comment on proposals
|
|
|
+### 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 >
|
|
|
@@ -36,7 +36,7 @@ nearing the decision process. For more about the difference, see the
|
|
|
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
|
|
|
+### 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
|
|
|
@@ -49,12 +49,12 @@ eventually implemented. A good starting point is to read through the
|
|
|
[evolution process](docs/project/evolution.md). We encourage discussing the idea
|
|
|
early, before even writing a proposal, and the process explains how to do that.
|
|
|
|
|
|
-## Help implement Carbon's design
|
|
|
+### 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
|
|
|
+### 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
|
|
|
@@ -62,9 +62,9 @@ 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
|
|
|
+## How to become a contributor to Carbon
|
|
|
|
|
|
-## Contributor License Agreements (CLAs)
|
|
|
+### 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.
|
|
|
@@ -87,14 +87,14 @@ accept your documents, comments and pull requests.
|
|
|
CLA can be accepted as Carbon contributions: this covers the GitHub repository,
|
|
|
GitHub issues, Google Docs, Discourse Forums, and Discord Chat.
|
|
|
|
|
|
-### Future CLA plans
|
|
|
+#### Future CLA plans
|
|
|
|
|
|
At present, we are using Google's CLA. In the future, we expect the Carbon
|
|
|
ownership and IP to formally transfer from Google to a Carbon-specific
|
|
|
foundation or other neutral third-party. When that happens, the foundation will
|
|
|
take ownership of providing a CLA.
|
|
|
|
|
|
-## Collaboration systems
|
|
|
+### Collaboration systems
|
|
|
|
|
|
We use a few systems for collaboration which contributors should be aware of.
|
|
|
Membership is currently invite-only.
|
|
|
@@ -138,12 +138,12 @@ the Code of Conduct.
|
|
|
[Google Group](https://groups.google.com/g/carbon-lang-contributors) used
|
|
|
for access.
|
|
|
|
|
|
-## Contribution guidelines and standards
|
|
|
+### 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
|
|
|
+#### Guidelines and philosophy for contributions
|
|
|
|
|
|
- For **both** documentation and code:
|
|
|
|
|
|
@@ -184,9 +184,9 @@ follow the Carbon documentation and coding styles.
|
|
|
- Keep in mind that code contribution guidelines are incomplete while we start
|
|
|
work on Carbon, and may change later.
|
|
|
|
|
|
-# Style
|
|
|
+## Style
|
|
|
|
|
|
-## Google Docs and Markdown
|
|
|
+### Google Docs and Markdown
|
|
|
|
|
|
Changes to Carbon documentation follow the
|
|
|
[Google developer documentation style guide](https://developers.google.com/style).
|
|
|
@@ -199,21 +199,21 @@ Other style points to be aware of are:
|
|
|
- Always say "Discourse Forum" and "Discord Chat" to avoid confusion between
|
|
|
systems.
|
|
|
|
|
|
-## Other files
|
|
|
+### Other files
|
|
|
|
|
|
If you're not sure what style to use, please ask on Discourse Forums.
|
|
|
|
|
|
-# License
|
|
|
+## License
|
|
|
|
|
|
A license is required at the top of all documents and files.
|
|
|
|
|
|
-## Google Docs
|
|
|
+### Google Docs
|
|
|
|
|
|
Google Docs all use
|
|
|
[this template](https://docs.google.com/document/d/1sqEnIWWZKTrtMz2XgD7_RqvogwbI0tBQjAZIvOabQsw/template/preview).
|
|
|
It puts the license at the top of every page if printed.
|
|
|
|
|
|
-## Markdown
|
|
|
+### Markdown
|
|
|
|
|
|
Markdown files always have at the top:
|
|
|
|
|
|
@@ -229,13 +229,13 @@ For example, see the top of
|
|
|
[CONTRIBUTING.md](https://github.com/carbon-language/carbon-lang/raw/master/CONTRIBUTING.md)'s
|
|
|
raw content.
|
|
|
|
|
|
-## Other files
|
|
|
+### 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 Discourse Forums.
|
|
|
|
|
|
-# Acknowledgements
|
|
|
+## Acknowledgements
|
|
|
|
|
|
Carbon's Contributing guidelines are based on
|
|
|
[Tensorflow](https://github.com/tensorflow/tensorflow/blob/master/CONTRIBUTING.md)
|