Files
abseil-cpp/CONTRIBUTING.md
Abseil Team fcb104594b Creation of LTS branch "lts_2018_12_18"
- 44b0fafc62 Export of internal Abseil changes. by Abseil Team <absl-team@google.com>
  - 926bfeb9ff Export of internal Abseil changes. by Abseil Team <absl-team@google.com>
  - 13327debeb Export of internal Abseil changes. by Abseil Team <absl-team@google.com>
  - 3088e76c59 Export of internal Abseil changes. by Abseil Team <absl-team@google.com>
  - f6ae816808 Export of internal Abseil changes. by Abseil Team <absl-team@google.com>
  - a06c4a1d90 Export of internal Abseil changes. by Abseil Team <absl-team@google.com>
  - 7b46e1d31a Export of internal Abseil changes. by Abseil Team <absl-team@google.com>
  - 070f6e47b3 Export of internal Abseil changes. by Abseil Team <absl-team@google.com>
  - 7990fd459e Export of internal Abseil changes. by Abseil Team <absl-team@google.com>
  - f95179062e Export of internal Abseil changes. by Abseil Team <absl-team@google.com>
  - cc8dcd307b Export of internal Abseil changes. by Abseil Team <absl-team@google.com>
  - a705aa78dc Merge pull request #194 from Mizux/windows by Xiaoyi Zhang <zhangxy988@gmail.com>
  - a4c3ffff11 Export of internal Abseil changes. by Abseil Team <absl-team@google.com>
  - 0117457865 Merge pull request #201 from ccawley2011/fix-byteswap by Matt Calabrese <38107210+mattcalabrese-google@users.noreply.github.com>
  - f86f941385 Export of internal Abseil changes. by Abseil Team <absl-team@google.com>
  - 94c298e2a0 Export of internal Abseil changes. by Abseil Team <absl-team@google.com>
  - 0884a6a04e Export of internal Abseil changes. by Abseil Team <absl-team@google.com>
  - c16d5557cd Export of internal Abseil changes. by Abseil Team <absl-team@google.com>
  - 45221ccc4e Export of internal Abseil changes. by Abseil Team <absl-team@google.com>
  - 2019e17a52 Export of internal Abseil changes. by Abseil Team <absl-team@google.com>
  - 5b70a8910b Export of internal Abseil changes. by Abseil Team <absl-team@google.com>
  - a00bdd176d Export of internal Abseil changes. by Abseil Team <absl-team@google.com>
  - f340f773ed Export of internal Abseil changes. by Abseil Team <absl-team@google.com>
  - 445998d7ac Export of internal Abseil changes. by Abseil Team <absl-team@google.com>
  - e821380d69 Export of internal Abseil changes. by Abseil Team <absl-team@google.com>
  - f21d187b80 Export of internal Abseil changes. by Abseil Team <absl-team@google.com>
  - 5441bbe1db Fix code snippet in comment (#174) by Loo Rong Jie <loorongjie@gmail.com>
  - 5aae0cffae Fix CMake build (#173) by Stephan Dollberg <stephan.dollberg@gmail.com>
  - 48cd2c3f35 Export of internal Abseil changes. by Abseil Team <absl-team@google.com>
  - e291c279e4 Export of internal Abseil changes. by Abseil Team <absl-team@google.com>
  - e01d95528e Export of internal Abseil changes. by Abseil Team <absl-team@google.com>
  - 8ff1374008 Export of internal Abseil changes. by Abseil Team <absl-team@google.com>
  - 02451914b9 Export of internal Abseil changes. by Abseil Team <absl-team@google.com>
  - 921fd5cf02 Merge pull request #166 from rongjiecomputer/cmake-test by Gennadiy Civil <gennadiycivil@users.noreply.github.com>
  - fb462224c0 Export of internal Abseil changes. by Abseil Team <absl-team@google.com>
  - c075ad3216 Export of internal Abseil changes. by Abseil Team <absl-team@google.com>
  - 0f4bc96675 Export of internal Abseil changes. by Abseil Team <absl-team@google.com>
  - 6c7e5ffc43 Export of internal Abseil changes. by Abseil Team <absl-team@google.com>
  - d6df769173 Export of internal Abseil changes. by Abseil Team <absl-team@google.com>
  - 28080f5f05 Export of internal Abseil changes. by Abseil Team <absl-team@google.com>
  - 9c987f429b Export of internal Abseil changes. by Abseil Team <absl-team@google.com>
  - 5e7d459eec Export of internal Abseil changes. by Abseil Team <absl-team@google.com>
  - bed5bd6e18 Export of internal Abseil changes. by Abseil Team <absl-team@google.com>
  - fefc83638f Export of internal Abseil changes. by Abseil Team <absl-team@google.com>
  - d8cfe9f2a7 Export of internal Abseil changes. by Abseil Team <absl-team@google.com>
  - ad5c960b2e Export of internal Abseil changes. by Abseil Team <absl-team@google.com>
  - 86f0fe93ad Export of internal Abseil changes. by Abseil Team <absl-team@google.com>
  - f0f15c2778 Export of internal Abseil changes. by Abseil Team <absl-team@google.com>
  - 29ff6d4860 Removed "warning treated as error" flag from MSVC (#153) by vocaviking <vocaviking@users.noreply.github.com>
  - 083d04dd4a Export of internal Abseil changes. by Abseil Team <absl-team@google.com>
  - bea85b5273 Export of internal Abseil changes. by Abseil Team <absl-team@google.com>
  - 8f96be6ca6 Export of internal Abseil changes. by Abseil Team <absl-team@google.com>
  - 92e07e5590 Merge pull request #152 from clnperez/fix-multi-defines-p... by Derek Mauro <761129+derekmauro@users.noreply.github.com>
  - 2125e6444a Export of internal Abseil changes. by Abseil Team <absl-team@google.com>
  - 9acad869d2 Merge pull request #150 from OlafvdSpek/patch-2 by Jonathan Cohen <cohenjon@google.com>
  - c2e00d3419 Export of internal Abseil changes. by Abseil Team <absl-team@google.com>
  - 9e060686d1 Export of internal Abseil changes. by Abseil Team <absl-team@google.com>
  - 7aa411ceaf Export of internal Abseil changes. by Abseil Team <absl-team@google.com>
  - 2c5af55ed3 Export of internal Abseil changes. by Abseil Team <absl-team@google.com>
  - 44aa275286 Merge pull request #143 from rongjiecomputer/kernel by Xiaoyi Zhang <zhangxy988@gmail.com>
  - 42f22a2840 Export of internal Abseil changes. by Abseil Team <absl-team@google.com>
  - b973bc53ef Merge pull request #139 from siepkes/smartos-support by ahedberg <ahedberg@google.com>
  - e0def7473e Export of internal Abseil changes. by Abseil Team <absl-team@google.com>
  - f826f1d489 Merge pull request #138 from edbaunton/remove-deprecated-... by ahedberg <ahedberg@google.com>
  - 7b50a4a94b Export of internal Abseil changes. by Abseil Team <absl-team@google.com>
  - a5030ca512 Merge pull request #144 from rongjiecomputer/winsock2 by Xiaoyi Zhang <zhangxy988@gmail.com>
  - 02687955b7 Export of internal Abseil changes. by Abseil Team <absl-team@google.com>
  - 8f612ebb15 Export of internal Abseil changes. by Abseil Team <absl-team@google.com>
  - 134496a31d Export of internal Abseil changes. by Abseil Team <absl-team@google.com>
  - ba8d6cf077 Export of internal Abseil changes. by Abseil Team <absl-team@google.com>
  - be1e84b988 Export of internal Abseil changes. by Abseil Team <absl-team@google.com>
  - 16ac2ec2e3 Merge pull request #134 from rongjiecomputer/cmake by Alex Strelnikov <strel@google.com>
  - 7efd8dc0f1 Export of internal Abseil changes. by Abseil Team <absl-team@google.com>
  - 87a4c07856 Export of internal Abseil changes. by Abseil Team <absl-team@google.com>
  - 4491d606df Export of internal Abseil changes. by Abseil Team <absl-team@google.com>

GitOrigin-RevId: 44b0fafc62
Change-Id: I2c427b5b41b2d34101922048b00f3d9dafcb498d
2018-12-04 16:54:40 -05:00

6.5 KiB
Raw Permalink Blame History

How to Contribute to Abseil

We'd love to accept your patches and contributions to this project. There are just a few small guidelines you need to follow.

NOTE: If you are new to GitHub, please start by reading Pull Request howto

Contributor License Agreement

Contributions to this project must be accompanied by a Contributor License Agreement. You (or your employer) retain the copyright to your contribution, this simply gives us permission to use and redistribute your contributions as part of the project. Head over to https://cla.developers.google.com/ to see your current agreements on file or to sign a new one.

You generally only need to submit a CLA once, so if you've already submitted one (even if it was for a different project), you probably don't need to do it again.

Contribution Guidelines

Potential contributors sometimes ask us if the Abseil project is the appropriate home for their utility library code or for specific functions implementing missing portions of the standard. Often, the answer to this question is "no". Wed like to articulate our thinking on this issue so that our choices can be understood by everyone and so that contributors can have a better intuition about whether Abseil might be interested in adopting a new library.

Priorities

Although our mission is to augment the C++ standard library, our goal is not to provide a full forward-compatible implementation of the latest standard. For us to consider a library for inclusion in Abseil, it is not enough that a library is useful. We generally choose to release a library when it meets at least one of the following criteria:

  • Widespread usage - Using our internal codebase to help gauge usage, most of the libraries we've released have tens of thousands of users.
  • Anticipated widespread usage - Pre-adoption of some standard-compliant APIs may not have broad adoption initially but can be expected to pick up usage when it replaces legacy APIs. absl::from_chars, for example, replaces existing code that converts strings to numbers and will therefore likely see usage growth.
  • High impact - APIs that provide a key solution to a specific problem, such as absl::FixedArray, have higher impact than usage numbers may signal and are released because of their importance.
  • Direct support for a library that falls under one of the above - When we want access to a smaller library as an implementation detail for a higher-priority library we plan to release, we may release it, as we did with portions of absl/meta/type_traits.h. One consequence of this is that the presence of a library in Abseil does not necessarily mean that other similar libraries would be a high priority.

API Freeze Consequences

Via the Abseil Compatibility Guidelines, we have promised a large degree of API stability. In particular, we will not make backward-incompatible changes to released APIs without also shipping a tool or process that can upgrade our users' code. We are not yet at the point of easily releasing such tools. Therefore, at this time, shipping a library establishes an API contract which is borderline unchangeable. (We can add new functionality, but we cannot easily change existing behavior.) This constraint forces us to very carefully review all APIs that we ship.

Coding Style

To keep the source consistent, readable, diffable and easy to merge, we use a fairly rigid coding style, as defined by the google-styleguide project. All patches will be expected to conform to the style outlined here.

Guidelines for Pull Requests

  • If you are a Googler, it is preferable to first create an internal CL and have it reviewed and submitted. The code propagation process will deliver the change to GitHub.

  • Create small PRs that are narrowly focused on addressing a single concern. We often receive PRs that are trying to fix several things at a time, but if only one fix is considered acceptable, nothing gets merged and both author's & review's time is wasted. Create more PRs to address different concerns and everyone will be happy.

  • For speculative changes, consider opening an Abseil issue and discussing it first. If you are suggesting a behavioral or API change, consider starting with an Abseil proposal template.

  • Provide a good PR description as a record of what change is being made and why it was made. Link to a GitHub issue if it exists.

  • Don't fix code style and formatting unless you are already changing that line to address an issue. Formatting of modified lines may be done using git clang-format. PRs with irrelevant changes won't be merged. If you do want to fix formatting or style, do that in a separate PR.

  • Unless your PR is trivial, you should expect there will be reviewer comments that you'll need to address before merging. We expect you to be reasonably responsive to those comments, otherwise the PR will be closed after 2-3 weeks of inactivity.

  • Maintain clean commit history and use meaningful commit messages. PRs with messy commit history are difficult to review and won't be merged. Use rebase -i upstream/master to curate your commit history and/or to bring in latest changes from master (but avoid rebasing in the middle of a code review).

  • Keep your PR up to date with upstream/master (if there are merge conflicts, we can't really merge your change).

  • All tests need to be passing before your change can be merged. We recommend you run tests locally (see below)

  • Exceptions to the rules can be made if there's a compelling reason for doing so. That is - the rules are here to serve us, not the other way around, and the rules need to be serving their intended purpose to be valuable.

  • All submissions, including submissions by project members, require review.

Running Tests

Use "bazel test <>" functionality to run the unit tests.

Prerequisites for building and running tests are listed in README.md

Abseil Committers

The current members of the Abseil engineering team are the only committers at present.

Release Process

Abseil lives at head, where latest-and-greatest code can be found.