You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+39-26Lines changed: 39 additions & 26 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,70 +1,80 @@
1
1
# Contributing
2
2
3
-
Each pull request should address a single issue, and contain both the fix and a description of how the pull request and tests that validate that the PR fixes the issue in question.
3
+
Each pull request should address a single issue, and contain both the fix and a description of how the pull request and
4
+
tests that validate that the PR fixes the issue in question.
4
5
5
-
For significant feature additions, we like to have an open issue in [MariaDB JIRA](https://mariadb.atlassian.net/secure/RapidBoard.jspa?projectKey=CONJ). It is expected that discussion will have taken place in the attached issue.
6
+
For significant feature additions, we like to have an open issue
7
+
in [MariaDB JIRA](https://mariadb.atlassian.net/secure/RapidBoard.jspa?projectKey=CONJ). It is expected that discussion
8
+
will have taken place in the attached issue.
6
9
7
10
# Install Prerequisites
8
11
9
-
These are the set of tools which are required in order to complete any build. Follow the links to download and install them on your own before continuing.
12
+
These are the set of tools which are required in order to complete any build. Follow the links to download and install
13
+
them on your own before continuing.
10
14
11
15
* At least one GPG Key see https://help.github.com/en/articles/generating-a-new-gpg-key
12
-
*[Oracle JDK 8](http://www.oracle.com/technetwork/java/javase/downloads/index.html) ( with [JCE policies](http://www.oracle.com/technetwork/java/javase/downloads/jce8-download-2133166.html) if using TLS/SSL)
Run the test locally : by default, you need to have a MySQL/MariaDB server on localhost:3306 with a database named "testj" and a user root without password.
29
-
so you can run
30
-
34
+
Run the test locally : by default, you need to have a MySQL/MariaDB server on localhost:3306 with a database named "
35
+
testj" and a user root without password.
36
+
so you can run
37
+
31
38
```script
32
39
mvn test
33
40
```
34
-
35
-
You can change this parameter by adding -DdbUrl parameter. like :
36
-
41
+
42
+
You can change this parameter by adding -DdbUrl parameter. like :
43
+
37
44
```script
38
45
mvn test -DdbUrl=jdbc:mariadb://127.0.0.1:3306/testj?user=root&password=*****
39
46
```
40
-
47
+
41
48
You can launch a specific test by adding -Dtest
42
49
43
50
```script
44
51
mvn test -Dtest=org.mariadb.jdbc.JdbcParserTest
45
52
```
46
-
53
+
47
54
When all test are passing, you can package project.
48
-
Additional tests , like javadoc formatting, code style validation will be done :
49
-
55
+
Additional tests , like javadoc formatting, code style validation will be done :
56
+
50
57
```script
51
58
mvn package -Dmaven.test.skip=true
52
59
```
53
-
60
+
54
61
If operation succeed, a new mariadb-java-client jar will be on the target folder.
55
-
62
+
56
63
# Run travis test
57
-
58
-
You can activate travis to validate your repository.
59
-
The advantage of travis compare to running test locally is that it will launch tests for a combination of those parameters :
64
+
65
+
You can activate travis to validate your repository.
66
+
The advantage of travis compare to running test locally is that it will launch tests for a combination of those
67
+
parameters :
60
68
61
69
jdk:
70
+
62
71
* oraclejdk8
63
-
and if your work is on develop-jre6 branch
72
+
and if your work is on develop-jre6 branch
64
73
* openjdk6
65
74
* openjdk7
66
75
67
76
server :
77
+
68
78
* MariaDB 5.5
69
79
* MariaDB 10.0
70
80
* MariaDB 10.1
@@ -73,17 +83,20 @@ server :
73
83
* MySQL 5.7
74
84
75
85
max_allowed_packet : (this permit to check multipacket send)
86
+
76
87
* 8M
77
88
* 20M
78
89
* 40M
79
90
80
-
For that, you have to go on [travis website](https://travis-ci.org), connect with your github account, and activate your mariadb-connector-j repository.
81
-
After this step, every push to your repository will launch a travis test.
91
+
For that, you have to go on [travis website](https://travis-ci.org), connect with your github account, and activate your
92
+
mariadb-connector-j repository.
93
+
After this step, every push to your repository will launch a travis test.
82
94
83
95
## Submitting a request
84
96
85
-
When your repository has the correction/change done, you can submit a pull request by clicking the "Pull request" button on github.
86
-
Please detail the operation done in your request.
97
+
When your repository has the correction/change done, you can submit a pull request by clicking the "Pull request" button
MariaDB java connector is a JDBC 4.2 compatible driver, used to connect applications developed in Java to MariaDB and MySQL databases. MariaDB Connector/J is LGPL licensed.
9
+
MariaDB java connector is a JDBC 4.2 compatible driver, used to connect applications developed in Java to MariaDB and
10
+
MySQL databases. MariaDB Connector/J is LGPL licensed.
10
11
11
12
Tracker link <ahref="https://jira.mariadb.org/projects/CONJ/issues/">https://jira.mariadb.org/projects/CONJ/issues/</a>
[](http://opensource.org/licenses/LGPL-2.1)
@@ -21,7 +23,8 @@ Tracker link <a href="https://jira.mariadb.org/projects/CONJ/issues/">https://ji
21
23
For java 8+ :
22
24
23
25
The driver (jar) can be downloaded from [mariadb connector download](https://mariadb.com/downloads/#connectors)
24
-
or maven :
26
+
or maven :
27
+
25
28
```script
26
29
<dependency>
27
30
<groupId>org.mariadb.jdbc</groupId>
@@ -30,8 +33,8 @@ or maven :
30
33
</dependency>
31
34
```
32
35
33
-
34
36
Development snapshot are available on sonatype nexus repository
37
+
35
38
```script
36
39
<repositories>
37
40
<repository>
@@ -52,12 +55,13 @@ Development snapshot are available on sonatype nexus repository
52
55
53
56
## Documentation
54
57
55
-
For a Getting started guide, API docs, recipes, etc. see the
58
+
For a Getting started guide, API docs, recipes, etc. see the
0 commit comments