Skip to content

Commit f1c1b74

Browse files
garydgregorygarydgregory
committed
Regenerate for 1.11.
git-svn-id: https://svn.apache.org/repos/asf/commons/proper/codec/trunk@1811904 13f79535-47bb-0310-9956-ffa450edef68
1 parent 178b0e1 commit f1c1b74

2 files changed

Lines changed: 134 additions & 113 deletions

File tree

‎CONTRIBUTING.md‎

Lines changed: 29 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -51,47 +51,65 @@ Getting Started
5151
+ Make sure you have a [JIRA account](https://issues.apache.org/jira/).
5252
+ Make sure you have a [GitHub account](https://github.com/signup/free).
5353
+ If you're planning to implement a new feature it makes sense to discuss you're 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 Codec's scope.
54-
+ Submit a ticket for your issue, assuming one does not already exist.
54+
+ Submit a [Jira Ticket][jira] for your issue, assuming one does not already exist.
5555
+ Clearly describe the issue including steps to reproduce when it is a bug.
5656
+ Make sure you fill in the earliest version that you know has the issue.
57-
+ Fork the repository on GitHub.
57+
+ 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.
5859

5960
Making Changes
6061
--------------
6162

62-
+ Create a topic branch from where you want to base your work (this is usually the master/trunk branch).
63+
+ Create a _topic branch_ for your isolated work.
64+
* Usually you should base your branch on the `master` or `trunk` branch.
65+
* A good topic branch name can be the JIRA bug id plus a keyword, e.g. `CODEC-123-InputStream`.
66+
* If you have submitted multiple JIRA issues, try to maintain separate branches and pull requests.
6367
+ Make commits of logical units.
68+
* Make sure your commit messages are meaningful and in the proper format. Your commit message should contain the key of the JIRA issue.
69+
* e.g. `CODEC-123: Close input stream earlier`
6470
+ Respect the original code style:
6571
+ Only use spaces for indentation.
66-
+ 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.
67-
+ Check for unnecessary whitespace with git diff --check before committing.
68-
+ Make sure your commit messages are in the proper format. Your commit message should contain the key of the JIRA issue.
69-
+ Make sure you have added the necessary tests for your changes.
72+
+ 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+
+ Check for unnecessary whitespace with `git diff` -- check before committing.
74+
+ Make sure you have added the necessary tests for your changes, typically in `src/test/java`.
7075
+ Run all the tests with `mvn clean verify` to assure nothing else was accidentally broken.
7176

7277
Making Trivial Changes
7378
----------------------
7479

80+
The JIRA tickets are used to generate the changelog for the next release.
81+
7582
For changes of a trivial nature to comments and documentation, it is not always necessary to create a new ticket in JIRA.
7683
In this case, it is appropriate to start the first line of a commit with '(doc)' instead of a ticket number.
7784

85+
7886
Submitting Changes
7987
------------------
8088

81-
+ Sign the [Contributor License Agreement][cla] if you haven't already.
89+
+ Sign and submit the Apache [Contributor License Agreement][cla] if you haven't already.
90+
* Note that small patches & typical bug fixes do not require a CLA as
91+
clause 5 of the [Apache License](https://www.apache.org/licenses/LICENSE-2.0.html#contributions)
92+
covers them.
8293
+ Push your changes to a topic branch in your fork of the repository.
83-
+ Submit a pull request to the repository in the apache organization.
94+
+ Submit a _Pull Request_ to the corresponding repository in the `apache` organization.
95+
* Verify _Files Changed_ shows only your intended changes and does not
96+
include additional files like `target/*.class`
8497
+ Update your JIRA ticket and include a link to the pull request in the ticket.
8598

99+
If you prefer to not use GitHub, then you can instead use
100+
`git format-patch` (or `svn diff`) and attach the patch file to the JIRA issue.
101+
102+
86103
Additional Resources
87104
--------------------
88105

89106
+ [Contributing patches](https://commons.apache.org/patches.html)
90-
+ [Apache Commons Codec JIRA project page](https://issues.apache.org/jira/browse/CODEC)
107+
+ [Apache Commons Codec JIRA project page][jira]
91108
+ [Contributor License Agreement][cla]
92109
+ [General GitHub documentation](https://help.github.com/)
93110
+ [GitHub pull request documentation](https://help.github.com/send-pull-requests/)
94111
+ [Apache Commons Twitter Account](https://twitter.com/ApacheCommons)
95-
+ #apachecommons IRC channel on freenode.org
112+
+ `#apache-commons` IRC channel on `irc.freenode.net`
96113

97114
[cla]:https://www.apache.org/licenses/#clas
115+
[jira]:https://issues.apache.org/jira/browse/CODEC

‎README.md‎

Lines changed: 105 additions & 102 deletions
Original file line numberDiff line numberDiff line change
@@ -1,105 +1,108 @@
1-
<!---
2-
Licensed to the Apache Software Foundation (ASF) under one or more
3-
contributor license agreements. See the NOTICE file distributed with
4-
this work for additional information regarding copyright ownership.
5-
The ASF licenses this file to You under the Apache License, Version 2.0
6-
(the "License"); you may not use this file except in compliance with
7-
the License. You may obtain a copy of the License at
8-
9-
http://www.apache.org/licenses/LICENSE-2.0
10-
11-
Unless required by applicable law or agreed to in writing, software
12-
distributed under the License is distributed on an "AS IS" BASIS,
13-
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14-
See the License for the specific language governing permissions and
15-
limitations under the License.
16-
-->
17-
<!---
18-
+======================================================================+
19-
|**** ****|
20-
|**** THIS FILE IS GENERATED BY THE COMMONS BUILD PLUGIN ****|
21-
|**** DO NOT EDIT DIRECTLY ****|
22-
|**** ****|
23-
+======================================================================+
24-
| TEMPLATE FILE: readme-md-template.md |
25-
| commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates |
26-
+======================================================================+
27-
| |
28-
| 1) Re-generate using: mvn commons:readme-md |
29-
| |
30-
| 2) Set the following properties in the component's pom: |
31-
| - commons.componentid (required, alphabetic, lower case) |
32-
| - commons.release.version (required) |
33-
| |
34-
| 3) Example Properties |
35-
| |
36-
| <properties> |
37-
| <commons.componentid>math</commons.componentid> |
38-
| <commons.release.version>1.2</commons.release.version> |
39-
| </properties> |
40-
| |
41-
+======================================================================+
42-
--->
43-
Apache Commons Codec
44-
===================
45-
46-
[![Build Status](https://travis-ci.org/apache/commons-codec.svg?branch=trunk)](https://travis-ci.org/apache/commons-codec)
47-
1+
<!---
2+
Licensed to the Apache Software Foundation (ASF) under one or more
3+
contributor license agreements. See the NOTICE file distributed with
4+
this work for additional information regarding copyright ownership.
5+
The ASF licenses this file to You under the Apache License, Version 2.0
6+
(the "License"); you may not use this file except in compliance with
7+
the License. You may obtain a copy of the License at
8+
9+
http://www.apache.org/licenses/LICENSE-2.0
10+
11+
Unless required by applicable law or agreed to in writing, software
12+
distributed under the License is distributed on an "AS IS" BASIS,
13+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14+
See the License for the specific language governing permissions and
15+
limitations under the License.
16+
-->
17+
<!---
18+
+======================================================================+
19+
|**** ****|
20+
|**** THIS FILE IS GENERATED BY THE COMMONS BUILD PLUGIN ****|
21+
|**** DO NOT EDIT DIRECTLY ****|
22+
|**** ****|
23+
+======================================================================+
24+
| TEMPLATE FILE: readme-md-template.md |
25+
| commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates |
26+
+======================================================================+
27+
| |
28+
| 1) Re-generate using: mvn commons:readme-md |
29+
| |
30+
| 2) Set the following properties in the component's pom: |
31+
| - commons.componentid (required, alphabetic, lower case) |
32+
| - commons.release.version (required) |
33+
| |
34+
| 3) Example Properties |
35+
| |
36+
| <properties> |
37+
| <commons.componentid>math</commons.componentid> |
38+
| <commons.release.version>1.2</commons.release.version> |
39+
| </properties> |
40+
| |
41+
+======================================================================+
42+
--->
43+
Apache Commons Codec
44+
===================
45+
46+
[![Build Status](https://travis-ci.org/apache/commons-codec.svg?branch=master)](https://travis-ci.org/apache/commons-codec)
47+
[![Coverage Status](https://coveralls.io/repos/apache/commons-codec/badge.svg?branch=master)](https://coveralls.io/r/apache/commons-codec)
48+
[![Maven Central](https://maven-badges.herokuapp.com/maven-central/commons-codec/commons-codec/badge.svg)](https://maven-badges.herokuapp.com/maven-central/commons-codec/commons-codec/)
49+
[![License](http://img.shields.io/:license-apache-blue.svg)](http://www.apache.org/licenses/LICENSE-2.0.html)
50+
4851
The Apache Commons Codec package contains simple encoder and decoders for
4952
various formats such as Base64 and Hexadecimal. In addition to these
5053
widely used encoders and decoders, the codec package also maintains a
51-
collection of phonetic encoding utilities.
52-
53-
Documentation
54-
-------------
55-
56-
More information can be found on the [Apache Commons Codec homepage](https://commons.apache.org/proper/commons-codec).
57-
The [JavaDoc](https://commons.apache.org/proper/commons-codec/javadocs/api-release) can be browsed.
58-
Questions related to the usage of Apache Commons Codec should be posted to the [user mailing list][ml].
59-
60-
Where can I get the latest release?
61-
-----------------------------------
62-
You can download source and binaries from our [download page](https://commons.apache.org/proper/commons-codec/download_codec.cgi).
63-
64-
Alternatively you can pull it from the central Maven repositories:
65-
66-
```xml
67-
<dependency>
68-
<groupId>commons-codec</groupId>
69-
<artifactId>commons-codec</artifactId>
70-
<version>1.11</version>
71-
</dependency>
72-
```
73-
74-
Contributing
75-
------------
76-
77-
We accept Pull Requests via GitHub. The [developer mailing list][ml] is the main channel of communication for contributors.
78-
There are some guidelines which will make applying PRs easier for us:
79-
+ No tabs! Please use spaces for indentation.
80-
+ Respect the code style.
81-
+ 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.
82-
+ Provide JUnit tests for your changes and make sure your changes don't break any existing tests by running ```mvn clean test```.
83-
84-
If you plan to contribute on a regular basis, please consider filing a [contributor license agreement](https://www.apache.org/licenses/#clas).
85-
You can learn more about contributing via GitHub in our [contribution guidelines](CONTRIBUTING.md).
86-
87-
License
88-
-------
89-
This code is under the [Apache Licence v2](https://www.apache.org/licenses/LICENSE-2.0).
90-
91-
See the `NOTICE.txt` file for required notices and attributions.
92-
93-
Donations
94-
---------
95-
You like Apache Commons Codec? Then [donate back to the ASF](https://www.apache.org/foundation/contributing.html) to support the development.
96-
97-
Additional Resources
98-
--------------------
99-
100-
+ [Apache Commons Homepage](https://commons.apache.org/)
101-
+ [Apache Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/CODEC)
102-
+ [Apache Commons Twitter Account](https://twitter.com/ApacheCommons)
103-
+ `#apache-commons` IRC channel on `irc.freenode.org`
104-
105-
[ml]:https://commons.apache.org/mail-lists.html
54+
collection of phonetic encoding utilities.
55+
56+
Documentation
57+
-------------
58+
59+
More information can be found on the [Apache Commons Codec homepage](https://commons.apache.org/proper/commons-codec).
60+
The [JavaDoc](https://commons.apache.org/proper/commons-codec/javadocs/api-release) can be browsed.
61+
Questions related to the usage of Apache Commons Codec should be posted to the [user mailing list][ml].
62+
63+
Where can I get the latest release?
64+
-----------------------------------
65+
You can download source and binaries from our [download page](https://commons.apache.org/proper/commons-codec/download_codec.cgi).
66+
67+
Alternatively you can pull it from the central Maven repositories:
68+
69+
```xml
70+
<dependency>
71+
<groupId>commons-codec</groupId>
72+
<artifactId>commons-codec</artifactId>
73+
<version>1.11</version>
74+
</dependency>
75+
```
76+
77+
Contributing
78+
------------
79+
80+
We accept Pull Requests via GitHub. The [developer mailing list][ml] is the main channel of communication for contributors.
81+
There are some guidelines which will make applying PRs easier for us:
82+
+ No tabs! Please use spaces for indentation.
83+
+ Respect the code style.
84+
+ 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.
85+
+ Provide JUnit tests for your changes and make sure your changes don't break any existing tests by running ```mvn clean test```.
86+
87+
If you plan to contribute on a regular basis, please consider filing a [contributor license agreement](https://www.apache.org/licenses/#clas).
88+
You can learn more about contributing via GitHub in our [contribution guidelines](CONTRIBUTING.md).
89+
90+
License
91+
-------
92+
This code is under the [Apache Licence v2](https://www.apache.org/licenses/LICENSE-2.0).
93+
94+
See the `NOTICE.txt` file for required notices and attributions.
95+
96+
Donations
97+
---------
98+
You like Apache Commons Codec? Then [donate back to the ASF](https://www.apache.org/foundation/contributing.html) to support the development.
99+
100+
Additional Resources
101+
--------------------
102+
103+
+ [Apache Commons Homepage](https://commons.apache.org/)
104+
+ [Apache Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/CODEC)
105+
+ [Apache Commons Twitter Account](https://twitter.com/ApacheCommons)
106+
+ `#apache-commons` IRC channel on `irc.freenode.org`
107+
108+
[ml]:https://commons.apache.org/mail-lists.html

0 commit comments

Comments
 (0)