Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[core] Add a CONTRIBUTING.md file to fix #245. #1026

Closed
wants to merge 1 commit into from

Conversation

manolama
Copy link
Collaborator

No description provided.

Copy link
Collaborator

@jasontedor jasontedor left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I left a few corrections but otherwise LGTM.

CONTRIBUTING.md Outdated
-->
## How To Contribute

As more and more databases are created to handle distributed or "cloud" workloads, YCSB needs contributes to write clients to test them. And of course we always need bug fixes, updates for existing databases and new features to keep YCSB going. Here are some guidelines to follow when digging into the code.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

contributes -> contributors

CONTRIBUTING.md Outdated

## Issues and Support

To track bugs, feature request and releases we use GitHub's integrated [Issues](https://github.com/brianfrankcooper/YCSB/issues). If you find a bug or problem, open an issue with a descriptive title and as many details as you can give us in the body (stack traces, log files, etc). Then if you can create a fix, follow the PR guidelines below.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

request -> requests

CONTRIBUTING.md Outdated

## Platforms

Since most data bases aim to support multiple platforms, YCSB aims to run on as many as possible as well. Besides **Linux** and **MacOS**, YCSB must compile and run for **Windows**. While not all DBs will run under every platform, the YCSB tool itself must be able to execute on all of these systems and hopefully be able to communicate with remote data stores.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: MacOS -> macOS

CONTRIBUTING.md Outdated

Since most data bases aim to support multiple platforms, YCSB aims to run on as many as possible as well. Besides **Linux** and **MacOS**, YCSB must compile and run for **Windows**. While not all DBs will run under every platform, the YCSB tool itself must be able to execute on all of these systems and hopefully be able to communicate with remote data stores.

Additionally, YCSB is targeting Java 7 (1.7.0) as it's build system as some users are glacially slow moving to Java 8. So please avoid those Lambdas and Streams for now.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it's -> its

Copy link
Collaborator

@risdenk risdenk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good including @jasontedor comments.

@risdenk risdenk added this to the 0.13.0 milestone Sep 20, 2017
@manolama
Copy link
Collaborator Author

Merged in 942a317

@manolama manolama closed this Sep 20, 2017
@manolama manolama mentioned this pull request Sep 26, 2017
@busbey busbey mentioned this pull request May 19, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants