Submitting Feedback - nosqlbench/nosqlbench GitHub Wiki

Please take a moment to review this document in order to make the contribution process easy and effective for everyone involved.

Following these guidelines helps to communicate that you respect the time of the developers managing and developing this project. In return, they should reciprocate that respect in addressing your issue or assessing patches and features.

The issue tracker is the preferred channel for bug reports, feature requests, but please respect the following restrictions:

• Please do not use the issue tracker for personal support requests. If you file an issue, you should be sure that it is not sufficiently covered in the docs.

• Please do not derail or troll issues. Keep the discussion on topic and respect the opinions of others.

A bug is a demonstrable problem that is caused by the code in the repository. Good bug reports are extremely helpful - thank you!

If you think you have found a bug, please file a bug report. NoSQLBench is actively used within DataStax, and verified bugs will get attention as resources permit. Bugs reports which are more detailed, or bug reports which include steps to reproduce will get attention first.

Guidelines for bug reports:

1. Use the GitHub issue search — check if the issue has already been reported.

2. Check if the issue has been fixed — try to reproduce it using the latest version of NoSQLBench.

3. Isolate the problem — create a test scenario that makes it easy to demonstrate the problem.

A good bug report shouldn't leave others needing to chase you up for more information. Please try to be as detailed as possible in your report. What is your environment? What steps will reproduce the issue? What browser(s) and OS experience the problem? What would you expect to be the outcome? All these details will help people to fix any potential bugs.

Example:

Short and descriptive example bug report title

A summary of the issue and the browser/OS environment in which it occurs. If suitable, include the steps required to reproduce the bug.

1. This is the first step
2. This is the second step
3. Further steps, etc.

<url> - a link to the reduced test case

Any other information you want to share that is relevant to the issue being reported. This might include the lines of code that you have identified as causing the bug, and potential solutions (and your opinions on their merits).

If you would like to see something in NoSQLBench that is not there yet, please submit a feature request. Please provide as much detail and context as possible, or examples which make it very clear how a user should expect to use such feature.

Feature requests are welcome. But take a moment to find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Please provide as much detail and context as possible.

If you have an idea that is a cross-cutting change or a significant amount of effort to implement, be sure to raise it in an issue and discuss it. The project maintainers want to make the NoSQLBench stable for everyone, so we need to work together to paint a picture of upcoming releases. This means that large pull requests with a high risk surface will not automatically be merged to master. It is the discretion of the maintainers to chose when to put a pull request on pause pending further discussion. That said, we absolutely do want to have more contributors, and we will do everything we can to help new contributors be productive within the project. Discussing and planning non-trivial changes is a part of project maturation, and something that everyone should expect.

If you would like to see a specific NoSQLBench or testing topic added to the guidebook, please request docs content.