Skip to content

Commit 8b07ff1

Browse files
committed
Update contributing guidelines.
* Align CONTRIBUTING.md with the google/new-project template. * Explain the support story for the CMake config. PiperOrigin-RevId: 421311695
1 parent 65dc7b3 commit 8b07ff1

File tree

2 files changed

+35
-24
lines changed

2 files changed

+35
-24
lines changed

CONTRIBUTING.md

+9-24
Original file line numberDiff line numberDiff line change
@@ -3,30 +3,10 @@
33
We'd love to accept your patches and contributions to this project. There are
44
just a few small guidelines you need to follow.
55

6-
## Project Goals
7-
8-
In addition to the aims listed at the top of the [README](README.md) Snappy
9-
explicitly supports the following:
10-
11-
1. C++11
12-
2. Clang (gcc and MSVC are best-effort).
13-
3. Low level optimizations (e.g. assembly or equivalent intrinsics) for:
14-
1. [x86](https://en.wikipedia.org/wiki/X86)
15-
2. [x86-64](https://en.wikipedia.org/wiki/X86-64)
16-
3. ARMv7 (32-bit)
17-
4. ARMv8 (AArch64)
18-
4. Supports only the Snappy compression scheme as described in
19-
[format_description.txt](format_description.txt).
20-
5. CMake for building
21-
22-
Changes adding features or dependencies outside of the core area of focus listed
23-
above might not be accepted. If in doubt post a message to the
24-
[Snappy discussion mailing list](https://groups.google.com/g/snappy-compression).
25-
266
## Contributor License Agreement
277

288
Contributions to this project must be accompanied by a Contributor License
29-
Agreement. You (or your employer) retain the copyright to your contribution,
9+
Agreement. You (or your employer) retain the copyright to your contribution;
3010
this simply gives us permission to use and redistribute your contributions as
3111
part of the project. Head over to <https://cla.developers.google.com/> to see
3212
your current agreements on file or to sign a new one.
@@ -35,12 +15,17 @@ You generally only need to submit a CLA once, so if you've already submitted one
3515
(even if it was for a different project), you probably don't need to do it
3616
again.
3717

38-
## Code reviews
18+
## Code Reviews
3919

4020
All submissions, including submissions by project members, require review. We
4121
use GitHub pull requests for this purpose. Consult
4222
[GitHub Help](https://help.github.com/articles/about-pull-requests/) for more
4323
information on using pull requests.
4424

45-
Please make sure that all the automated checks (CLA, AppVeyor, Travis) pass for
46-
your pull requests. Pull requests whose checks fail may be ignored.
25+
See [the README](README.md#contributing-to-the-snappy-project) for areas
26+
where we are likely to accept external contributions.
27+
28+
## Community Guidelines
29+
30+
This project follows [Google's Open Source Community
31+
Guidelines](https://opensource.google/conduct/).

README.md

+26
Original file line numberDiff line numberDiff line change
@@ -131,6 +131,32 @@ should provide a reasonably balanced starting point for benchmarking. (Note that
131131
baddata[1-3].snappy are not intended as benchmarks; they are used to verify
132132
correctness in the presence of corrupted data in the unit test.)
133133

134+
Contributing to the Snappy Project
135+
==================================
136+
137+
In addition to the aims listed at the top of the [README](README.md) Snappy
138+
explicitly supports the following:
139+
140+
1. C++11
141+
2. Clang (gcc and MSVC are best-effort).
142+
3. Low level optimizations (e.g. assembly or equivalent intrinsics) for:
143+
1. [x86](https://en.wikipedia.org/wiki/X86)
144+
2. [x86-64](https://en.wikipedia.org/wiki/X86-64)
145+
3. ARMv7 (32-bit)
146+
4. ARMv8 (AArch64)
147+
4. Supports only the Snappy compression scheme as described in
148+
[format_description.txt](format_description.txt).
149+
5. CMake for building
150+
151+
Changes adding features or dependencies outside of the core area of focus listed
152+
above might not be accepted. If in doubt post a message to the
153+
[Snappy discussion mailing list](https://groups.google.com/g/snappy-compression).
154+
155+
We are unlikely to accept contributions to the build configuration files, such
156+
as `CMakeLists.txt`. We are focused on maintaining a build configuration that
157+
allows us to test that the project works in a few supported configurations
158+
inside Google. We are not currently interested in supporting other requirements,
159+
such as different operating systems, compilers, or build systems.
134160

135161
Contact
136162
=======

0 commit comments

Comments
 (0)