Skip to content

Commit 9c23180

Browse files
garydgregorygarydgregory
committed
Add README.md and CONTRIBUTING.md.
git-svn-id: https://svn.apache.org/repos/asf/commons/proper/codec/trunk@1747082 13f79535-47bb-0310-9956-ffa450edef68
1 parent c7b540b commit 9c23180

2 files changed

Lines changed: 198 additions & 0 deletions

File tree

‎CONTRIBUTING.md‎

Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
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: contributing-md-template.md |
25+
| commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates |
26+
+======================================================================+
27+
| |
28+
| 1) Re-generate using: mvn commons:contributing-md |
29+
| |
30+
| 2) Set the following properties in the component's pom: |
31+
| - commons.jira.id (required, alphabetic, upper case) |
32+
| |
33+
| 3) Example Properties |
34+
| |
35+
| <properties> |
36+
| <commons.jira.id>MATH</commons.jira.id> |
37+
| </properties> |
38+
| |
39+
+======================================================================+
40+
--->
41+
Contributing to Apache Commons Codec
42+
======================
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.
47+
48+
Getting Started
49+
---------------
50+
51+
+ 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).
53+
+ 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.
55+
+ Clearly describe the issue including steps to reproduce when it is a bug.
56+
+ Make sure you fill in the earliest version that you know has the issue.
57+
+ Fork the repository on GitHub.
58+
59+
Making Changes
60+
--------------
61+
62+
+ Create a topic branch from where you want to base your work (this is usually the master/trunk branch).
63+
+ Make commits of logical units.
64+
+ Respect the original code style:
65+
+ 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.
70+
+ Run all the tests with `mvn clean verify` to assure nothing else was accidentally broken.
71+
72+
Making Trivial Changes
73+
----------------------
74+
75+
For changes of a trivial nature to comments and documentation, it is not always necessary to create a new ticket in JIRA.
76+
In this case, it is appropriate to start the first line of a commit with '(doc)' instead of a ticket number.
77+
78+
Submitting Changes
79+
------------------
80+
81+
+ Sign the [Contributor License Agreement][cla] if you haven't already.
82+
+ 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.
84+
+ Update your JIRA ticket and include a link to the pull request in the ticket.
85+
86+
Additional Resources
87+
--------------------
88+
89+
+ [Contributing patches](https://commons.apache.org/patches.html)
90+
+ [Apache Commons Codec JIRA project page](https://issues.apache.org/jira/browse/CODEC)
91+
+ [Contributor License Agreement][cla]
92+
+ [General GitHub documentation](https://help.github.com/)
93+
+ [GitHub pull request documentation](https://help.github.com/send-pull-requests/)
94+
+ [Apache Commons Twitter Account](https://twitter.com/ApacheCommons)
95+
+ #apachecommons IRC channel on freenode.org
96+
97+
[cla]:https://www.apache.org/licenses/#clas

‎README.md‎

Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
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+
The Apache Commons Codec package contains simple encoder and decoders for
47+
various formats such as Base64 and Hexadecimal. In addition to these
48+
widely used encoders and decoders, the codec package also maintains a
49+
collection of phonetic encoding utilities.
50+
51+
Documentation
52+
-------------
53+
54+
More information can be found on the [homepage](https://commons.apache.org/proper/commons-codec).
55+
The [JavaDoc](https://commons.apache.org/proper/commons-codec/javadocs/api-release) can be browsed.
56+
Questions related to the usage of Apache Commons Codec should be posted to the [user mailing list][ml].
57+
58+
Where can I get the latest release?
59+
-----------------------------------
60+
You can download source and binaries from our [download page](https://commons.apache.org/proper/commons-codec/download_codec.cgi).
61+
62+
Alternatively you can pull it from the central Maven repositories:
63+
64+
```xml
65+
<dependency>
66+
<groupId>commons-codec</groupId>
67+
<artifactId>commons-codec</artifactId>
68+
<version>1.11</version>
69+
</dependency>
70+
```
71+
72+
Contributing
73+
------------
74+
75+
We accept PRs via github. The [developer mailing list][ml] is the main channel of communication for contributors.
76+
There are some guidelines which will make applying PRs easier for us:
77+
+ No tabs! Please use spaces for indentation.
78+
+ Respect the code style.
79+
+ 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.
80+
+ Provide JUnit tests for your changes and make sure your changes don't break any existing tests by running ```mvn clean test```.
81+
82+
If you plan to contribute on a regular basis, please consider filing a [contributor license agreement](https://www.apache.org/licenses/#clas).
83+
You can learn more about contributing via GitHub in our [contribution guidelines](CONTRIBUTING.md).
84+
85+
License
86+
-------
87+
Code is under the [Apache Licence v2](https://www.apache.org/licenses/LICENSE-2.0.txt).
88+
89+
Donations
90+
---------
91+
You like Apache Commons Codec? Then [donate back to the ASF](https://www.apache.org/foundation/contributing.html) to support the development.
92+
93+
Additional Resources
94+
--------------------
95+
96+
+ [Apache Commons Homepage](https://commons.apache.org/)
97+
+ [Apache Bugtracker (JIRA)](https://issues.apache.org/jira/)
98+
+ [Apache Commons Twitter Account](https://twitter.com/ApacheCommons)
99+
+ #apachecommons IRC channel on freenode.org
100+
101+
[ml]:https://commons.apache.org/mail-lists.html

0 commit comments

Comments
 (0)