Fixup various documentation files

Initial version of issue template, pull request template, changelog, contribution guidelines and dependency info in the readme.
This commit is contained in:
Kurt Nelson 2019-07-03 10:55:38 -07:00
parent d00c6ebd47
commit 2664e43d16
No known key found for this signature in database
GPG key ID: 0EFE12A6534804FF
7 changed files with 126 additions and 0 deletions

5
.github/ISSUE_TEMPLATE.md vendored Normal file
View file

@ -0,0 +1,5 @@
Before you create an issue, please consider the following points:
- [ ] If you think you found a bug, please include a code sample that reproduces the problem. A test case that reproduces the issue is preferred. A stack trace alone is ok but may not contain enough context for us to address the issue.
- [ ] Please include the library version number, including the minor and patch version, in the issue text.

32
.github/ISSUE_TEMPLATE/bug_report.md vendored Normal file
View file

@ -0,0 +1,32 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: ''
assignees: ''
---
**Describe the bug**
A clear and concise description of what the bug is.
**To Reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
**Expected behavior**
A clear and concise description of what you expected to happen.
**Screenshots**
If applicable, add screenshots to help explain your problem.
**Smartphone (please complete the following information):**
- Device: [e.g. Nexus One]
- OS: [e.g. 4.4]
- Version [e.g. 22]
**Additional context**
Add any other context about the problem here.

View file

@ -0,0 +1,20 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: ''
assignees: ''
---
**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
**Describe the solution you'd like**
A clear and concise description of what you want to happen.
**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.
**Additional context**
Add any other context or screenshots about the feature request here.

7
.github/PULL_REQUEST_TEMPLATE.md vendored Normal file
View file

@ -0,0 +1,7 @@
Before pressing the "Create Pull Request" button, please provide the following:
- [ ] A description about what and why you are contributing, even if it's trivial.
- [ ] The issue number(s) or PR number(s) in the description if you are contributing in response to those.
- [ ] If applicable, unit tests.

7
CHANGELOG.md Executable file
View file

@ -0,0 +1,7 @@
Changelog
=========
Version 0.0.5
----------------------------
* Initial release

31
CONTRIBUTING.md Executable file
View file

@ -0,0 +1,31 @@
Contributing to SimpleStore
=======================
Uber welcomes contributions of all kinds and sizes. This includes everything from from simple bug reports to large features.
Workflow
--------
We love GitHub issues!
For small feature requests, an issue first proposing it for discussion or demo implementation in a PR suffice.
For big features, please open an issue so that we can agree on the direction, and hopefully avoid investing a lot of time on a feature that might need reworking.
Small pull requests for things like typos, bug fixes, etc are always welcome.
DOs and DON'Ts
--------------
* DO follow our [coding style](https://github.com/uber/java-code-styles)
* DO include tests when adding new features. When fixing bugs, start with adding a test that highlights how the current behavior is broken.
* DO keep the discussions focused. When a new or related topic comes up it's often better to create new issue than to side track the discussion.
* DON'T submit PRs that alter licensing related files or headers. If you believe there's a problem with them, file an issue and we'll be happy to discuss it.
Guiding Principles
------------------
* We allow anyone to participate in our projects. Tasks can be carried out by anyone that demonstrates the capability to complete them
* Always be respectful of one another. Assume the best in others and act with empathy at all times
* Collaborate closely with individuals maintaining the project or experienced users. Getting ideas out in the open and seeing a proposal before it's a pull request helps reduce redundancy and ensures we're all connected to the decision making process

View file

@ -10,6 +10,14 @@ All values are stored on disk as plain files that are “scoped” to a matching
## Basic usage
To include in a gradle project, add to your dependencies:
```
dependencies {
implementation 'com.uber.simplestore:simplestore:0.0.5'
}
```
Out of the box, SimpleStore uses `ListenableFuture` to store `byte[]`, `String`, primitives and protocol buffers on internal storage. Note that if you use RxJava, it comes with a `fromFuture` method that allows you to wrap `ListenableFuture`.
```java
@ -70,3 +78,19 @@ All operations are guaranteed to be executed in-order within the same scope. A s
This model makes deadlock across scopes impossible, as even a blockingGet cannot be issued on the ordered IO executor. Adopting this model leaves us room to experiment later with using explicit thread priority for different scopes.
## License
Copyright (C) 2019 Uber Technologies
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.