Skip to content

Commit f79d749

Browse files
vadegvadeg
committed
Added contribution guide.
Changed license to MIT. Fixed repository url. Fixed readme according to Zalando OSS rules.
1 parent e22ba07 commit f79d749

File tree

4 files changed

+51
-35
lines changed

4 files changed

+51
-35
lines changed

‎CONTRIBUTING.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Contributing guidelines
2+
3+
Here are several recommendations how to contribute to the `java-sproc-wrapper` project.
4+
5+
## Reporting issues
6+
7+
If you have a question or have a problem using `java-sproc-wrapper`, please read the [README](README.md) before filing an issue.
8+
9+
## Contributing a pull request
10+
11+
1. Submit a comment to the relevant issue or create a new issue describing your proposed change.
12+
1. Do a fork, develop and test your code changes.
13+
1. Include documentation
14+
1. Submit a pull request.
15+
16+
You'll get feedback about your pull request as soon as possible.

‎LICENSE

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,9 @@
1-
Copyright 2014 Zalando SE
1+
The MIT License
22

3-
Licensed under the Apache License, Version 2.0 (the "License");
4-
you may not use this file except in compliance with the License.
5-
You may obtain a copy of the License at
3+
Copyright 2012-2017 Zalando SE
64

7-
http://www.apache.org/licenses/LICENSE-2.0
5+
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
86

9-
Unless required by applicable law or agreed to in writing, software
10-
distributed under the License is distributed on an "AS IS" BASIS,
11-
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12-
See the License for the specific language governing permissions and
13-
limitations under the License.
7+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
8+
9+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

‎README.md

Lines changed: 7 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ Note: SProcwrapper doesn't support functions returning arrays as a single output
110110
Prerequisites
111111
-------------
112112

113-
* Java 7
113+
* Java 8
114114
* To compile, one should use [Maven](http://maven.apache.org/) 2.1.0 or above
115115

116116
Dependencies
@@ -119,7 +119,7 @@ Dependencies
119119
* Spring Framework
120120
* PostgreSQL JDBC driver ;)
121121
* Google Guava
122-
* and more see `pom.xml` for details
122+
* and more see [pom.xml](pom.xml) for details
123123

124124
How to run integration tests
125125
----------------------------
@@ -149,20 +149,12 @@ You can find some more information about the SProcWrapper in our various Zalando
149149
* http://tech.zalando.com/blog/zalando-stored-procedure-wrapper-part-i/
150150
* http://tech.zalando.com/blog/files/2013/04/jug_dortmund_april_2013.pdf
151151

152+
## Contributing
152153

153-
License
154-
-------
155-
156-
Copyright 2012-2014 Zalando SE
154+
See [contributing guideline](CONTRIBUTING.md).
157155

158-
Licensed under the Apache License, Version 2.0 (the "License");
159-
you may not use this file except in compliance with the License.
160-
You may obtain a copy of the License at
161156

162-
http://www.apache.org/licenses/LICENSE-2.0
157+
License
158+
-------
163159

164-
Unless required by applicable law or agreed to in writing, software
165-
distributed under the License is distributed on an "AS IS" BASIS,
166-
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
167-
See the License for the specific language governing permissions and
168-
limitations under the License.
160+
MIT license. See [license file](LICENSE).

‎pom.xml

Lines changed: 22 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,24 @@
11
<?xml version='1.0' encoding='UTF-8'?>
2-
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
2+
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
3+
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
34
<modelVersion>4.0.0</modelVersion>
45
<parent>
56
<groupId>org.zalando.stups.build</groupId>
67
<artifactId>stups-parent</artifactId>
78
<version>7</version>
8-
<relativePath />
9+
<relativePath/>
910
</parent>
1011
<groupId>de.zalando</groupId>
1112
<artifactId>zalando-sprocwrapper</artifactId>
1213
<version>2.0.0-SNAPSHOT</version>
1314
<packaging>jar</packaging>
1415
<name>Stored Procedure Wrapper</name>
15-
<description>Library to make PostgreSQL stored procedures available through simple Java "*SProcService" interfaces including automatic object serialization and deserialization (using typemapper and convention-over-configuration). Supports sharding, advisory locking, statement timeouts and PostgreSQL types such as enums and hstore.</description>
16-
<url>https://github.com/zalando/java-sproc-wrapper</url>
16+
<description>Library to make PostgreSQL stored procedures available through simple Java "*SProcService" interfaces
17+
including automatic object serialization and deserialization (using typemapper and
18+
convention-over-configuration). Supports sharding, advisory locking, statement timeouts and PostgreSQL types
19+
such as enums and hstore.
20+
</description>
21+
<url>https://github.com/zalando-incubator/java-sproc-wrapper</url>
1722

1823
<organization>
1924
<name>Zalando/Technology/Platform</name>
@@ -23,19 +28,20 @@
2328
<scm>
2429
<connection>scm:git:git://github.com/zalando/java-sproc-wrapper.git</connection>
2530
<developerConnection>scm:git:[email protected]:zalando/java-sproc-wrapper.git</developerConnection>
26-
<url>https://github.com/zalando/java-sproc-wrapper.git</url>
27-
<tag>HEAD</tag>
28-
</scm>
31+
<url>https://github.com/zalando-incubator/java-sproc-wrapper.git</url>
32+
<tag>HEAD</tag>
33+
</scm>
2934

3035
<issueManagement>
3136
<system>GitHub</system>
32-
<url>https://github.com/zalando/java-sproc-wrapper/issues</url>
37+
<url>https://github.com/zalando-incubator/java-sproc-wrapper/issues</url>
3338
</issueManagement>
3439

3540
<licenses>
3641
<license>
37-
<name>Apache License</name>
38-
<url>http://www.apache.org/licenses/LICENSE-2.0</url>
42+
<name>MIT License</name>
43+
<url>http://www.opensource.org/licenses/mit-license.php</url>
44+
<distribution>repo</distribution>
3945
</license>
4046
</licenses>
4147

@@ -52,6 +58,12 @@
5258
<organization>Zalando SE</organization>
5359
<organizationUrl>http://tech.zalando.com/</organizationUrl>
5460
</developer>
61+
<developer>
62+
<name>Vadim Shaigorodskiy</name>
63+
<email>[email protected]</email>
64+
<organization>Zalando SE</organization>
65+
<organizationUrl>http://tech.zalando.com/</organizationUrl>
66+
</developer>
5567
</developers>
5668

5769
<prerequisites>

0 commit comments

Comments
 (0)