You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by sd...@apache.org on 2016/07/22 07:33:51 UTC
commons-crypto git commit: Update autogen documents
Repository: commons-crypto
Updated Branches:
refs/heads/CRYPTO-1.0.0 ed1b6097c -> 850e4bd6f
Update autogen documents
Project: http://git-wip-us.apache.org/repos/asf/commons-crypto/repo
Commit: http://git-wip-us.apache.org/repos/asf/commons-crypto/commit/850e4bd6
Tree: http://git-wip-us.apache.org/repos/asf/commons-crypto/tree/850e4bd6
Diff: http://git-wip-us.apache.org/repos/asf/commons-crypto/diff/850e4bd6
Branch: refs/heads/CRYPTO-1.0.0
Commit: 850e4bd6f5449c49ab5522524892b13181847ce3
Parents: ed1b609
Author: Sun Dapeng <sd...@apache.org>
Authored: Fri Jul 22 15:12:47 2016 +0800
Committer: Sun Dapeng <sd...@apache.org>
Committed: Fri Jul 22 15:12:47 2016 +0800
----------------------------------------------------------------------
CONTRIBUTING.md | 40 +++++++++++-----------------------------
README.md | 14 ++++++--------
RELEASE-NOTES.txt | 4 ++--
src/changes/changes.xml | 2 +-
4 files changed, 20 insertions(+), 40 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/commons-crypto/blob/850e4bd6/CONTRIBUTING.md
----------------------------------------------------------------------
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 1d98bb4..dfe0203 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -51,65 +51,47 @@ Getting Started
+ Make sure you have a [JIRA account](https://issues.apache.org/jira/).
+ Make sure you have a [GitHub account](https://github.com/signup/free).
+ 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 Crypto's scope.
-+ Submit a [Jira Ticket][jira] for your issue, assuming one does not already exist.
++ Submit a ticket for your issue, assuming one does not already exist.
+ Clearly describe the issue including steps to reproduce when it is a bug.
+ Make sure you fill in the earliest version that you know has the issue.
-+ Find the corresponding [repository on GitHub](https://github.com/apache/?query=commons-),
-[fork](https://help.github.com/articles/fork-a-repo/) and check out your forked repository.
++ Fork the repository on GitHub.
Making Changes
--------------
-+ Create a _topic branch_ for your isolated work.
- * Usually you should base your branch on the `master` or `trunk` branch.
- * A good topic branch name can be the JIRA bug id plus a keyword, e.g. `CRYPTO-123-InputStream`.
- * If you have submitted multiple JIRA issues, try to maintain separate branches and pull requests.
++ Create a topic branch from where you want to base your work (this is usually the master/trunk branch).
+ Make commits of logical units.
- * Make sure your commit messages are meaningful and in the proper format. Your commit message should contain the key of the JIRA issue.
- * e.g. `CRYPTO-123: Close input stream earlier`
+ Respect the original code style:
+ Only use spaces for indentation.
- + 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.
- + Check for unnecessary whitespace with `git diff` -- check before committing.
-+ Make sure you have added the necessary tests for your changes, typically in `src/test/java`.
+ + 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.
+ + Check for unnecessary whitespace with git diff --check before committing.
++ Make sure your commit messages are in the proper format. Your commit message should contain the key of the JIRA issue.
++ Make sure you have added the necessary tests for your changes.
+ Run all the tests with `mvn clean verify` to assure nothing else was accidentally broken.
Making Trivial Changes
----------------------
-The JIRA tickets are used to generate the changelog for the next release.
-
For changes of a trivial nature to comments and documentation, it is not always necessary to create a new ticket in JIRA.
In this case, it is appropriate to start the first line of a commit with '(doc)' instead of a ticket number.
-
Submitting Changes
------------------
-+ Sign and submit the Apache [Contributor License Agreement][cla] if you haven't already.
- * Note that small patches & typical bug fixes do not require a CLA as
- clause 5 of the [Apache License](https://www.apache.org/licenses/LICENSE-2.0.html#contributions)
- covers them.
++ Sign the [Contributor License Agreement][cla] if you haven't already.
+ Push your changes to a topic branch in your fork of the repository.
-+ Submit a _Pull Request_ to the corresponding repository in the `apache` organization.
- * Verify _Files Changed_ shows only your intended changes and does not
- include additional files like `target/*.class`
++ Submit a pull request to the repository in the apache organization.
+ Update your JIRA ticket and include a link to the pull request in the ticket.
-If you prefer to not use GitHub, then you can instead use
-`git format-patch` (or `svn diff`) and attach the patch file to the JIRA issue.
-
-
Additional Resources
--------------------
+ [Contributing patches](https://commons.apache.org/patches.html)
-+ [Apache Commons Crypto JIRA project page][jira]
++ [Apache Commons Crypto JIRA project page](https://issues.apache.org/jira/browse/CRYPTO)
+ [Contributor License Agreement][cla]
+ [General GitHub documentation](https://help.github.com/)
+ [GitHub pull request documentation](https://help.github.com/send-pull-requests/)
+ [Apache Commons Twitter Account](https://twitter.com/ApacheCommons)
-+ `#apache-commons` IRC channel on `irc.freenode.net`
++ #apachecommons IRC channel on freenode.org
[cla]:https://www.apache.org/licenses/#clas
-[jira]:https://issues.apache.org/jira/browse/CRYPTO
http://git-wip-us.apache.org/repos/asf/commons-crypto/blob/850e4bd6/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index c1bf802..15b98ce 100644
--- a/README.md
+++ b/README.md
@@ -61,7 +61,7 @@ Features
2. Java stream API (CryptoInputStream/CryptoOutputStream) for high level stream encyrption/decryption.
3. Both optimized with high performance AES encryption/decryption. (1400 MB/s - 1700 MB/s throughput in modern Xeon processors).
4. JNI-based implementation to achieve comparable performance to the native C++ version based on OpenSsl.
-5. Portable across various operating systems (currently only Linux);
+5. Portable across various operating systems (currently only Linux/MacOSX/Windows);
Apache Commons Crypto loads the library according to your machine environment (it checks system properties, `os.name` and `os.arch`).
6. Simple usage. Add the commons-crypto-(version).jar file to your classpath.
@@ -96,7 +96,7 @@ The following provides more details on the included cryptographic software:
Documentation
-------------
-More information can be found on the [Apache Commons Crypto homepage](https://commons.apache.org/proper/commons-crypto).
+More information can be found on the [homepage](https://commons.apache.org/proper/commons-crypto).
The [JavaDoc](https://commons.apache.org/proper/commons-crypto/javadocs/api-release) can be browsed.
Questions related to the usage of Apache Commons Crypto should be posted to the [user mailing list][ml].
@@ -117,7 +117,7 @@ Alternatively you can pull it from the central Maven repositories:
Contributing
------------
-We accept Pull Requests via GitHub. The [developer mailing list][ml] is the main channel of communication for contributors.
+We accept PRs via github. The [developer mailing list][ml] is the main channel of communication for contributors.
There are some guidelines which will make applying PRs easier for us:
+ No tabs! Please use spaces for indentation.
+ Respect the code style.
@@ -129,9 +129,7 @@ You can learn more about contributing via GitHub in our [contribution guidelines
License
-------
-This code is under the [Apache Licence v2](https://www.apache.org/licenses/LICENSE-2.0).
-
-See the `NOTICE.txt` file for required notices and attributions.
+Code is under the [Apache Licence v2](https://www.apache.org/licenses/LICENSE-2.0.txt).
Donations
---------
@@ -141,8 +139,8 @@ Additional Resources
--------------------
+ [Apache Commons Homepage](https://commons.apache.org/)
-+ [Apache Bugtracker (JIRA)](https://issues.apache.org/jira/browse/@JIRA_ID@)
++ [Apache Bugtracker (JIRA)](https://issues.apache.org/jira/)
+ [Apache Commons Twitter Account](https://twitter.com/ApacheCommons)
-+ `#apache-commons` IRC channel on `irc.freenode.org`
++ #apachecommons IRC channel on freenode.org
[ml]:https://commons.apache.org/mail-lists.html
http://git-wip-us.apache.org/repos/asf/commons-crypto/blob/850e4bd6/RELEASE-NOTES.txt
----------------------------------------------------------------------
diff --git a/RELEASE-NOTES.txt b/RELEASE-NOTES.txt
index f98d1c4..691a30f 100644
--- a/RELEASE-NOTES.txt
+++ b/RELEASE-NOTES.txt
@@ -1,7 +1,7 @@
- Apache Commons Crypto 1.0.0
+ Apache Commons Crypto 1.0.0-SNAPSHOT
RELEASE NOTES
-The Apache Commons Crypto team is pleased to announce the release of Apache Commons Crypto 1.0.0
+The Apache Commons Crypto team is pleased to announce the release of Apache Commons Crypto 1.0.0-SNAPSHOT
Apache Commons Crypto is a cryptographic library optimized with AES-NI (Advanced Encryption
Standard New Instructions). It provides Java API for both cipher level and Java stream level.
http://git-wip-us.apache.org/repos/asf/commons-crypto/blob/850e4bd6/src/changes/changes.xml
----------------------------------------------------------------------
diff --git a/src/changes/changes.xml b/src/changes/changes.xml
index edc0322..2f9023c 100644
--- a/src/changes/changes.xml
+++ b/src/changes/changes.xml
@@ -61,7 +61,7 @@
-->
<body>
- <release version="1.0.0" date="2016-07-??" description="
+ <release version="1.0.0" date="2016-07-22" description="
Initial release
===============