leveldb/CONTRIBUTING.md

# Contributing

We'd love to accept your code patches! However, before we can take them, we
have to jump a couple of legal hurdles.

## Contributor License Agreements

Please fill out either the individual or corporate Contributor License
Agreement as appropriate.

* If you are an individual writing original source code and you're sure you
own the intellectual property, then sign an [individual CLA](https://developers.google.com/open-source/cla/individual).
* If you work for a company that wants to allow you to contribute your work,
then sign a [corporate CLA](https://developers.google.com/open-source/cla/corporate).

Follow either of the two links above to access the appropriate CLA and
instructions for how to sign and return it.

## Submitting a Patch

1. Sign the contributors license agreement above.
2. Decide which code you want to submit. A submission should be a set of changes
that addresses one issue in the [issue tracker](https://github.com/google/leveldb/issues).
Please don't mix more than one logical change per submission, because it makes
the history hard to follow. If you want to make a change
(e.g. add a sample or feature) that doesn't have a corresponding issue in the
issue tracker, please create one.
3. **Submitting**: When you are ready to submit, send us a Pull Request. Be
sure to include the issue number you fixed and the name you used to sign
the CLA.

## Writing Code ##

If your contribution contains code, please make sure that it follows 
[the style guide](http://google-styleguide.googlecode.com/svn/trunk/cppguide.xml).
Otherwise we will have to ask you to make changes, and that's no fun for anyone.
Release 1.18 Changes are: * Update version number to 1.18 * Replace the basic fprintf call with a call to fwrite in order to work around the apparent compiler optimization/rewrite failure that we are seeing with the new toolchain/iOS SDKs provided with Xcode6 and iOS8. * Fix ALL the header guards. * Createed a README.md with the LevelDB project description. * A new CONTRIBUTING file. * Don't implicitly convert uint64_t to size_t or int. Either preserve it as uint64_t, or explicitly cast. This fixes MSVC warnings about possible value truncation when compiling this code in Chromium. * Added a DumpFile() library function that encapsulates the guts of the "leveldbutil dump" command. This will allow clients to dump data to their log files instead of stdout. It will also allow clients to supply their own environment. * leveldb: Remove unused function 'ConsumeChar'. * leveldbutil: Remove unused member variables from WriteBatchItemPrinter. * OpenBSD, NetBSD and DragonflyBSD have _LITTLE_ENDIAN, so define PLATFORM_IS_LITTLE_ENDIAN like on FreeBSD. This fixes: * issue #143 * issue #198 * issue #249 * Switch from <cstdatomic> to <atomic>. The former never made it into the standard and doesn't exist in modern gcc versions at all. The later contains everything that leveldb was using from the former. This problem was noticed when porting to Portable Native Client where no memory barrier is defined. The fact that <cstdatomic> is missing normally goes unnoticed since memory barriers are defined for most architectures. * Make Hash() treat its input as unsigned. Before this change LevelDB files from platforms with different signedness of char were not compatible. This change fixes: issue #243 * Verify checksums of index/meta/filter blocks when paranoid_checks set. * Invoke all tools for iOS with xcrun. (This was causing problems with the new XCode 5.1.1 image on pulse.) * include <sys/stat.h> only once, and fix the following linter warning: "Found C system header after C++ system header" * When encountering a corrupted table file, return Status::Corruption instead of Status::InvalidArgument. * Support cygwin as build platform, patch is from https://code.google.com/p/leveldb/issues/detail?id=188 * Fix typo, merge patch from https://code.google.com/p/leveldb/issues/detail?id=159 * Fix typos and comments, and address the following two issues: * issue #166 * issue #241 * Add missing db synchronize after "fillseq" in the benchmark. * Removed unused variable in SeekRandom: value (issue #201) 2014-09-17 05:19:52 +08:00			`# Contributing`

			`We'd love to accept your code patches! However, before we can take them, we`
			`have to jump a couple of legal hurdles.`

			`## Contributor License Agreements`

			`Please fill out either the individual or corporate Contributor License`
			`Agreement as appropriate.`

			`* If you are an individual writing original source code and you're sure you`
			`own the intellectual property, then sign an [individual CLA](https://developers.google.com/open-source/cla/individual).`
			`* If you work for a company that wants to allow you to contribute your work,`
			`then sign a [corporate CLA](https://developers.google.com/open-source/cla/corporate).`

			`Follow either of the two links above to access the appropriate CLA and`
			`instructions for how to sign and return it.`

			`## Submitting a Patch`

			`1. Sign the contributors license agreement above.`
			`2. Decide which code you want to submit. A submission should be a set of changes`
			`that addresses one issue in the [issue tracker](https://github.com/google/leveldb/issues).`
			`Please don't mix more than one logical change per submission, because it makes`
			`the history hard to follow. If you want to make a change`
			`(e.g. add a sample or feature) that doesn't have a corresponding issue in the`
			`issue tracker, please create one.`
			`3. Submitting: When you are ready to submit, send us a Pull Request. Be`
			`sure to include the issue number you fixed and the name you used to sign`
			`the CLA.`

			`## Writing Code ##`

			`If your contribution contains code, please make sure that it follows`
			`[the style guide](http://google-styleguide.googlecode.com/svn/trunk/cppguide.xml).`
			`Otherwise we will have to ask you to make changes, and that's no fun for anyone.`