Skip to content

Commit a41e5ba

Browse files
author
Bulat Shakirzyanov
committed
update README and add contribution policy
1 parent 8e2c6e4 commit a41e5ba

File tree

2 files changed

+36
-1
lines changed

2 files changed

+36
-1
lines changed

CONTRIBUTING.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Contributing
2+
3+
## Reporting bugs
4+
5+
It is inevitable that code will have bugs. There are a few things you can do to
6+
help the maintainer to fix the bug that you've discovered quicker:
7+
8+
* [Use the PHP Driver Jira](https://datastax-oss.atlassian.net/projects/PHP) to report all issues and bugs.
9+
* Include the version of the Driver, PHP and Cassandra or DSE in your Jira ticket.
10+
* Include a complete stack trace of the failure as well as any available logs.
11+
* Include any additional information you think is relevant - the description of
12+
your setup, any non-default Driver configuration, etc.
13+
* Write a failing test. The PHP Driver uses [PHPUnit test framework](https://phpunit.de/). A reliably
14+
failing test is the fastest way to demonstrate and fix a problem.
15+
16+
## Pull Requests
17+
18+
If you're able to fix a bug yourself, you can [fork the repository](https://help.github.com/articles/fork-a-repo/) and [submit a pull request](https://help.github.com/articles/using-pull-requests/) with the fix.
19+
20+
To protect DataStax and the community, all contributors are required to [sign the DataStax Contribution License Agreement](http://cla.datastax.com/). The process is completely electronic and should only take a few minutes.

README.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,12 @@ __NOTE__: Apache Cassandra 2.1 support is limited to the Cassandra 2.0 API, e.g.
6363

6464
__NOTE__: Windows support is planned for a later, more stable release.
6565

66-
## What's new in v1.0.0.alpha
66+
## Status of v1.0.0.alpha
67+
68+
The current release is an early alpha. This means that it lacks some features
69+
and stability, but should be enough to start testing and working with Apache
70+
Cassandra. Below, you'll find a list of functionality that is already supported
71+
as well as what's plan for the upcoming releases.
6772

6873
Features:
6974

@@ -74,6 +79,16 @@ Features:
7479
* [SSL encryption](feature/ssl_encryption.feature).
7580
* [Credentials authentication](src/Cassandra/Cluster/Builder.php#L312-L320).
7681

82+
Planned:
83+
84+
* Windows support.
85+
* Expose [Schema Metadata](http://datastax.github.io/cpp-driver/api/struct_cass_session/#1afc51badec695483e4cde43ae0fc1e876).
86+
* Add arithmetic functions to numeric types.
87+
88+
## Contributing
89+
90+
[Read our contribution policy](CONTRIBUTING.md) for a detailed description of the process.
91+
7792
## Code examples
7893

7994
The DataStax PHP Driver uses the amazing [Behat Framework](http://docs.behat.org/)

0 commit comments

Comments
 (0)