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
+7-9Lines changed: 7 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@
6
6
(the "License"); you may not use this file except in compliance with
7
7
the License. You may obtain a copy of the License at
8
8
9
-
http://www.apache.org/licenses/LICENSE-2.0
9
+
https://www.apache.org/licenses/LICENSE-2.0
10
10
11
11
Unless required by applicable law or agreed to in writing, software
12
12
distributed under the License is distributed on an "AS IS" BASIS,
@@ -41,28 +41,27 @@
41
41
Contributing to Apache Commons Pool
42
42
======================
43
43
44
-
You have found a bug or you have an idea for a cool new feature? Contributing code is a great way to give something back to
45
-
the open source community. Before you dig right into the code there are a few guidelines that we need contributors to
46
-
follow so that we can have a chance of keeping on top of things.
44
+
Have you found a bug or have an idea for a cool new feature? Contributing code is a great way to give something back to the open-source community.
45
+
Before you dig right into the code, we need contributors to follow a few guidelines to have a chance of keeping on top of things.
47
46
48
47
Getting Started
49
48
---------------
50
49
51
50
+ Make sure you have a [JIRA account](https://issues.apache.org/jira/).
52
-
+ Make sure you have a [GitHub account](https://github.com/signup/free).
51
+
+ Make sure you have a [GitHub account](https://github.com/signup/free). This is not essential, but makes providing patches much easier.
53
52
+ If you're planning to implement a new feature it makes sense to discuss your changes on the [dev list](https://commons.apache.org/mail-lists.html) first. This way you can make sure you're not wasting your time on something that isn't considered to be in Apache Commons Pool's scope.
54
53
+ Submit a [Jira Ticket][jira] for your issue, assuming one does not already exist.
55
54
+ Clearly describe the issue including steps to reproduce when it is a bug.
56
55
+ Make sure you fill in the earliest version that you know has the issue.
57
56
+ Find the corresponding [repository on GitHub](https://github.com/apache/?query=commons-),
58
-
[fork](https://help.github.com/articles/fork-a-repo/) and check out your forked repository.
57
+
[fork](https://help.github.com/articles/fork-a-repo/) and check out your forked repository. If you don't have a GitHub account, you can still clone the Commons repository.
59
58
60
59
Making Changes
61
60
--------------
62
61
63
62
+ Create a _topic branch_ for your isolated work.
64
63
* Usually you should base your branch on the `master` branch.
65
-
* A good topic branch name can be the JIRA bug id plus a keyword, e.g. `POOL-123-InputStream`.
64
+
* A good topic branch name can be the JIRA bug ID plus a keyword, e.g. `POOL-123-InputStream`.
66
65
* If you have submitted multiple JIRA issues, try to maintain separate branches and pull requests.
67
66
+ Make commits of logical units.
68
67
* Make sure your commit messages are meaningful and in the proper format. Your commit message should contain the key of the JIRA issue.
@@ -72,7 +71,7 @@ Making Changes
72
71
+ Create minimal diffs - disable _On Save_ actions like _Reformat Source Code_ or _Organize Imports_. If you feel the source code should be reformatted create a separate PR for this change first.
73
72
+ Check for unnecessary whitespace with `git diff` -- check before committing.
74
73
+ Make sure you have added the necessary tests for your changes, typically in `src/test/java`.
75
-
+ Run all the tests with `mvn clean verify` to assure nothing else was accidentally broken.
74
+
+ Run all the tests with `mvn clean verify` to ensure nothing else was accidentally broken.
@@ -58,27 +58,35 @@ More information can be found on the [Apache Commons Pool homepage](https://comm
58
58
The [Javadoc](https://commons.apache.org/proper/commons-pool/apidocs) can be browsed.
59
59
Questions related to the usage of Apache Commons Pool should be posted to the [user mailing list](https://commons.apache.org/mail-lists.html).
60
60
61
-
Where can I get the latest release?
62
-
-----------------------------------
61
+
Getting the latest release
62
+
--------------------------
63
63
You can download source and binaries from our [download page](https://commons.apache.org/proper/commons-pool/download_pool.cgi).
64
64
65
-
Alternatively, you can pull it from the central Maven repositories:
65
+
Alternatively, you can pull it from the central Maven repositories:
66
66
67
67
```xml
68
68
<dependency>
69
69
<groupId>org.apache.commons</groupId>
70
70
<artifactId>commons-pool2</artifactId>
71
-
<version>2.12.0</version>
71
+
<version>2.12.1</version>
72
72
</dependency>
73
73
```
74
74
75
+
Building
76
+
--------
77
+
78
+
Building requires a Java JDK and [Apache Maven](https://maven.apache.org/).
79
+
The required Java version is found in the `pom.xml` as the `maven.compiler.source` property.
80
+
81
+
From a command shell, run `mvn` without arguments to invoke the default Maven goal to run all tests and checks.
82
+
75
83
Contributing
76
84
------------
77
85
78
86
We accept Pull Requests via GitHub. The [developer mailing list](https://commons.apache.org/mail-lists.html) is the main channel of communication for contributors.
79
87
There are some guidelines which will make applying PRs easier for us:
80
88
+ No tabs! Please use spaces for indentation.
81
-
+ Respect the code style.
89
+
+ Respect the existing code style for each file.
82
90
+ Create minimal diffs - disable on save actions like reformat source code or organize imports. If you feel the source code should be reformatted create a separate PR for this change.
83
91
+ Provide JUnit tests for your changes and make sure your changes don't break any existing tests by running `mvn`.
84
92
+ Before you pushing a PR, run `mvn` (by itself), this runs the default goal, which contains all build checks.
@@ -89,13 +97,13 @@ You can learn more about contributing via GitHub in our [contribution guidelines
89
97
90
98
License
91
99
-------
92
-
This code is under the [Apache Licence v2](https://www.apache.org/licenses/LICENSE-2.0).
100
+
This code is licensed under the [Apache License v2](https://www.apache.org/licenses/LICENSE-2.0).
93
101
94
102
See the `NOTICE.txt` file for required notices and attributions.
95
103
96
-
Donations
97
-
---------
98
-
You like Apache Commons Pool? Then [donate back to the ASF](https://www.apache.org/foundation/contributing.html) to support the development.
104
+
Donating
105
+
--------
106
+
You like Apache Commons Pool? Then [donate back to the ASF](https://www.apache.org/foundation/contributing.html) to support development.
Copy file name to clipboardExpand all lines: RELEASE-NOTES.txt
+50Lines changed: 50 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -1,3 +1,53 @@
1
+
Apache Commons Pool 2.12.1 Release Notes
2
+
----------------------------------------
3
+
4
+
The Apache Commons Pool team is pleased to announce the release of Apache Commons Pool 2.12.1.
5
+
6
+
Apache Commons Pool provides an object-pooling API and a number of object pool implementations.
7
+
Version 2 contains a completely re-written pooling implementation compared to the 1.x series.
8
+
In addition to performance and scalability improvements, version 2 includes robust instance
9
+
tracking and pool monitoring.
10
+
11
+
Version 2.7.x and up requires Java 8 or above.
12
+
Version 2.6.x requires Java 7 or above.
13
+
Version 2.5.x requires Java 7 or above.
14
+
Version 2.0 requires 6 or above.
15
+
16
+
NOTE: The MBean interfaces (DefaultPooledObjectInfoMBean, GenericKeyedObjectPoolMXBean
17
+
and GenericKeyedObjectPoolMXBean) exist only to define the attributes and methods
18
+
that will be made available via JMX. They must not be implemented by clients as
19
+
they are subject to change between major, minor and patch version releases of
20
+
Commons Pool. Clients that implement any of these interfaces may not, therefore,
21
+
be able to upgrade to a new minor or patch release without requiring code
22
+
changes.
23
+
24
+
${d}
25
+
26
+
Changes in version 2.12.1 include:
27
+
28
+
29
+
Fixed Bugs:
30
+
o Use java.time.Instant precision in org.apache.commons.pool2.impl.ThrowableCallStack.Snapshot throwable message. Thanks to Gary Gregory.
31
+
o GenericObjectPool.borrowObject(Duration) doesn't obey its borrowMaxWait Duration argument when the argument is different from GenericObjectPool.getMaxWaitDuration(). Thanks to Gary Gregory.
32
+
o POOL-418: The maximum wait time for GenericObjectPool.borrowObject(*) may exceed expectations due to a spurious thread wakeup. Thanks to Gary Gregory.
33
+
o Javadoc is missing its Overview page. Thanks to Gary Gregory.
34
+
o Migrate site generation templates to https://maven.apache.org/xsd/xdoc-2.0.xsd. Thanks to Gary Gregory.
35
+
36
+
Changes:
37
+
o Bump org.apache.commons:commons-parent from 62 to 79. Thanks to Gary Gregory.
38
+
o [test] Bump commons-lang3 from 3.13.0 to 3.17.0. Thanks to Gary Gregory.
39
+
o [site] Pickup org.apache.bcel:bcel version from parent POM. Thanks to Gary Gregory.
40
+
o [test] Bump org.ow2.asm:asm-util from 9.5 to 9.7.1. Thanks to Gary Gregory.
41
+
42
+
43
+
For complete information on Apache Commons Pool, including instructions on how to submit bug reports,
44
+
patches, or suggestions for improvement, see the Apache Commons Pool website:
0 commit comments