Skip to content

Commit

Permalink
Documentation: Add the request to add Speedb's license when modifying…
Browse files Browse the repository at this point in the history
… an existing RocksDB file (#744)
  • Loading branch information
udi-speedb committed Nov 23, 2023
1 parent 1dc40ff commit 5183292
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 0 deletions.
33 changes: 33 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -162,6 +162,8 @@ A license is required at the top of all documents and files.

### Source files

#### New Source Files

Every new source file should have the following header at the top:

```
Expand All @@ -182,6 +184,37 @@ limitations under the License.

Replace `<year>` in the copyright notice above with the current year.

#### RocksDB Source Files

When modifying files that exist in RocksDB that already have a Facebook or LevelDB license header
Add the following header at the top, **preceding the Facebook and/or LevelDB license header** as follows:

```
Copyright (C) <year> Speedb Ltd. All rights reserved.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
Copyright (c) 2011-present, Facebook, Inc. All rights reserved.
This source code is licensed under both the GPLv2 (found in the
COPYING file in the root directory) and Apache 2.0 License
(found in the LICENSE.Apache file in the root directory).
Copyright (c) 2011 The LevelDB Authors. All rights reserved.
Use of this source code is governed by a BSD-style license that can be
found in the LICENSE file. See the AUTHORS file for names of contributors.
```

Replace `<year>` in the copyright notice above with the current year.

### Markdown

Markdown files should have at the top:
Expand Down
1 change: 1 addition & 0 deletions HISTORY.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ Based on RocksDB 8.1.1

### Miscellaneous
* Unit tests: Disable CancelCompactionWaitingOnConflict and CompactionLimiter in db_compaction_test since they sometimes fail or get stuck. These need to be investigated and reenabled (#711).
* Documentation: Update CONTRIBUTING.md guide to request contributors to add Speedb's license when modifying existing Rocksdb Files (#713).

## Grapes v2.6.0 (8/22/2023)
Based on RocksDB 8.1.1
Expand Down

0 comments on commit 5183292

Please sign in to comment.