You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by ah...@apache.org on 2022/04/12 11:00:52 UTC
[commons-statistics] branch master updated (2238978 -> 6f7e015)
This is an automated email from the ASF dual-hosted git repository.
aherbert pushed a change to branch master
in repository https://gitbox.apache.org/repos/asf/commons-statistics.git
from 2238978 Update issue tracking guide
new 4b8a24e Remove ordered lists from inside paragraph block elements
new 6f7e015 Use https link
The 2 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
src/site/xdoc/developers.xml | 214 +++++++++++++++++++--------------------
src/site/xdoc/issue-tracking.xml | 6 +-
2 files changed, 109 insertions(+), 111 deletions(-)
[commons-statistics] 01/02: Remove ordered lists from inside paragraph block elements
Posted by ah...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
aherbert pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-statistics.git
commit 4b8a24e4fbacf7c3f2e11cc1429aeed37b61b714
Author: aherbert <ah...@apache.org>
AuthorDate: Tue Apr 12 11:40:04 2022 +0100
Remove ordered lists from inside paragraph block elements
---
src/site/xdoc/developers.xml | 214 +++++++++++++++++++--------------------
src/site/xdoc/issue-tracking.xml | 6 +-
2 files changed, 109 insertions(+), 111 deletions(-)
diff --git a/src/site/xdoc/developers.xml b/src/site/xdoc/developers.xml
index 5969191..acd1722 100644
--- a/src/site/xdoc/developers.xml
+++ b/src/site/xdoc/developers.xml
@@ -40,122 +40,120 @@
</p>
<subsection name="Contributing">
<p><strong>Getting Started</strong></p>
- <p>
- <ol>
- <li>
- Download the Commons Statistics source code. Follow the instructions
- under the heading "Repository Checkout" on the
- <a href="https://gitbox.apache.org/">Git at the ASF page</a>.
- The git url for the current development sources of Commons Statistics
- is <source>http://gitbox.apache.org/repos/asf/commons-statistics.git</source>
- for anonymous read-only access and
- <source>https://apacheid@gitbox.apache.org/repos/asf/commons-statistics.git</source>
- (where apacheid should be replaced by each committer Apache ID) for committers
- read-write access.
- </li>
- <li>
- Like most commons components, Commons Statistics uses Apache Maven as our
- build tool.
- To build Commons Statistics using Maven, you can follow the instructions for
- <a href="http://maven.apache.org/run-maven/index.html">Building a
- project with Maven</a>.
- Launch Maven from the top-level directory
- in the checkout of Commons Statistics trunk. No special setup is required,
- except that currently to build the site (i.e. to execute Maven's
- "site" goal), you may need to increase the default memory allocation
- (e.g. <code>export MAVEN_OPTS=-Xmx512m</code>) before launching
- Maven.
- </li>
- <li>
- Be sure to join the commons-dev and commons-user
- <a href="mail-lists.html">
- email lists</a> and use them appropriately (make sure the string
- "[Statistics]" starts the Subject line of all your postings).
- Make any proposals here where the group can comment on them.
- </li>
- <li>
- <a href="https://issues.apache.org/jira/secure/Signup!default.jspa">
- Setup an account on JIRA
- </a>
- and use it to submit patches and
- identify bugs. Read the
- <a href="https://issues.apache.org/bugwritinghelp.html">
- directions</a>
- for submitting bugs and search the database to
- determine if an issue exists or has already been dealt with.
- <br/>
- See the <a href="https://commons.apache.org/statistics/issue-tracking.html">
- Commons Statistics Issue Tracking Page</a>
- for more information on how to
- search for or submit bugs or enhancement requests.
- </li>
- <li>
- Generating patches: The requested format for generating patches is
- the Unified Diff format, which can be easily generated using the git
- client or various IDEs.
- <source>git diff -p > patch </source>
- Run this command from the top-level project directory (where pom.xml
- resides).
- </li>
- <li>
- Pull Requests: We accept pull requests (PRs) via the GitHub repository mirror.
- The Commons Statistics repository can be forked and changes merged via a PR.
- See <a href="https://docs.github.com/en/pull-requests/collaborating-with-pull-requests">
- collaborating with pull requests</a> for more information on pull requests.
- </li>
- </ol>
- </p>
+ <ol>
+ <li>
+ Download the Commons Statistics source code. Follow the instructions
+ under the heading "Repository Checkout" on the
+ <a href="https://gitbox.apache.org/">Git at the ASF page</a>.
+ The git url for the current development sources of Commons Statistics
+ is <source>http://gitbox.apache.org/repos/asf/commons-statistics.git</source>
+ for anonymous read-only access and
+ <source>https://apacheid@gitbox.apache.org/repos/asf/commons-statistics.git</source>
+ (where apacheid should be replaced by each committer Apache ID) for committers
+ read-write access.
+ </li>
+ <li>
+ Like most commons components, Commons Statistics uses Apache Maven as our
+ build tool.
+ To build Commons Statistics using Maven, you can follow the instructions for
+ <a href="http://maven.apache.org/run-maven/index.html">Building a
+ project with Maven</a>.
+ Launch Maven from the top-level directory
+ in the checkout of Commons Statistics trunk. No special setup is required,
+ except that currently to build the site (i.e. to execute Maven's
+ "site" goal), you may need to increase the default memory allocation
+ (e.g. <code>export MAVEN_OPTS=-Xmx512m</code>) before launching
+ Maven.
+ </li>
+ <li>
+ Be sure to join the commons-dev and commons-user
+ <a href="mail-lists.html">
+ email lists</a> and use them appropriately (make sure the string
+ "[Statistics]" starts the Subject line of all your postings).
+ Make any proposals here where the group can comment on them.
+ </li>
+ <li>
+ <a href="https://issues.apache.org/jira/secure/Signup!default.jspa">
+ Setup an account on JIRA
+ </a>
+ and use it to submit patches and
+ identify bugs. Read the
+ <a href="https://issues.apache.org/bugwritinghelp.html">
+ directions</a>
+ for submitting bugs and search the database to
+ determine if an issue exists or has already been dealt with.
+ <br/>
+ See the <a href="https://commons.apache.org/statistics/issue-tracking.html">
+ Commons Statistics Issue Tracking Page</a>
+ for more information on how to
+ search for or submit bugs or enhancement requests.
+ </li>
+ <li>
+ Generating patches: The requested format for generating patches is
+ the Unified Diff format, which can be easily generated using the git
+ client or various IDEs.
+ <source>git diff -p > patch </source>
+ Run this command from the top-level project directory (where pom.xml
+ resides).
+ </li>
+ <li>
+ Pull Requests: We accept pull requests (PRs) via the GitHub repository mirror.
+ The Commons Statistics repository can be forked and changes merged via a PR.
+ See <a href="https://docs.github.com/en/pull-requests/collaborating-with-pull-requests">
+ collaborating with pull requests</a> for more information on pull requests.
+ </li>
+ </ol>
<p><strong>Contributing ideas and code</strong></p>
<p>
Follow the steps below when making suggestions for additions or
enhancements to Commons Statistics. This will make it easier for the community
to comment on your ideas and for the committers to keep track of them.
Thanks in advance!
- <ol>
- <li>Start with a post to the commons-dev mailing list, with [Statistics] at
- the beginning of the subject line, followed by a short title
- describing the new feature or enhancement; for example, "[Statistics]
- New univariate distribution".
- The body of the post should include each of the following items
- (but be <strong>as brief as possible</strong>):
- <ul>
- <li>A concise description of the new feature / enhancement</li>
- <li>References to definitions and algorithms. Using standard
- definitions and algorithms makes communication much easier and will
- greatly increase the chances that we will accept the code / idea</li>
- <li>Some indication of why the addition / enhancement is practically
- useful</li>
- </ul></li>
- <li>Assuming a generally favorable response to the idea on commons-dev,
- the next step is to file a report on the issue-tracking system (JIRA).
- Create a JIRA ticket using the the feature title as the short
- description. Incorporate feedback from the initial posting in the
- description. Add a reference to the discussion thread.
+ </p>
+ <ol>
+ <li>Start with a post to the commons-dev mailing list, with [Statistics] at
+ the beginning of the subject line, followed by a short title
+ describing the new feature or enhancement; for example, "[Statistics]
+ New univariate distribution".
+ The body of the post should include each of the following items
+ (but be <strong>as brief as possible</strong>):
+ <ul>
+ <li>A concise description of the new feature / enhancement</li>
+ <li>References to definitions and algorithms. Using standard
+ definitions and algorithms makes communication much easier and will
+ greatly increase the chances that we will accept the code / idea</li>
+ <li>Some indication of why the addition / enhancement is practically
+ useful</li>
+ </ul></li>
+ <li>Assuming a generally favorable response to the idea on commons-dev,
+ the next step is to file a report on the issue-tracking system (JIRA).
+ Create a JIRA ticket using the the feature title as the short
+ description. Incorporate feedback from the initial posting in the
+ description. Add a reference to the discussion thread.
+ </li>
+ <li>Submit code as:
+ <ul>
+ <li>Attachments to the JIRA ticket. Please use one
+ ticket for each feature, adding multiple patches to the ticket
+ as necessary. Use the git diff command to generate your patches as
+ diffs. Please do not submit modified copies of existing java files.
</li>
- <li>Submit code as:
- <ul>
- <li>Attachments to the JIRA ticket. Please use one
- ticket for each feature, adding multiple patches to the ticket
- as necessary. Use the git diff command to generate your patches as
- diffs. Please do not submit modified copies of existing java files.
- </li>
- <li>A pull request (PR) via GitHub.
- To link the PR to a corresponding JIRA ticket prefix the PR title with
- <code>STATISTICS-xxx:</code> where <code>xxx</code> is the issue number.<br/>
- Please include quality commit messages with a single line title of about 50
- characters, followed by a blank line, followed by a more detailed explanation
- of the changeset. The title should be prefixed with the JIRA ticket number if
- applicable, e.g. <code>STATISTICS-xxx: New univariate distribution</code>.
- See <a href="https://git-scm.com/book/en/v2/Distributed-Git-Contributing-to-a-Project">
- contributing to a project</a> in the git book for guidelines on commit messages.
- </li>
- </ul>
- Be patient (but not <strong>too</strong> patient) with committers reviewing
- patches/PRs. Post a *nudge* message to commons-dev with a reference to the
- ticket if a submission goes more than a few days with no comment or commit.
+ <li>A pull request (PR) via GitHub.
+ To link the PR to a corresponding JIRA ticket prefix the PR title with
+ <code>STATISTICS-xxx:</code> where <code>xxx</code> is the issue number.<br/>
+ Please include quality commit messages with a single line title of about 50
+ characters, followed by a blank line, followed by a more detailed explanation
+ of the changeset. The title should be prefixed with the JIRA ticket number if
+ applicable, e.g. <code>STATISTICS-xxx: New univariate distribution</code>.
+ See <a href="https://git-scm.com/book/en/v2/Distributed-Git-Contributing-to-a-Project">
+ contributing to a project</a> in the git book for guidelines on commit messages.
</li>
- </ol>
- </p>
+ </ul>
+ Be patient (but not <strong>too</strong> patient) with committers reviewing
+ patches/PRs. Post a *nudge* message to commons-dev with a reference to the
+ ticket if a submission goes more than a few days with no comment or commit.
+ </li>
+ </ol>
</subsection>
<subsection name='Coding Style'>
diff --git a/src/site/xdoc/issue-tracking.xml b/src/site/xdoc/issue-tracking.xml
index 8295b45..68fae89 100644
--- a/src/site/xdoc/issue-tracking.xml
+++ b/src/site/xdoc/issue-tracking.xml
@@ -64,6 +64,7 @@ limitations under the License.
<p>
If you would like to report a bug, or raise an enhancement request with
Apache Commons Statistics please do the following:
+ </p>
<ol>
<li><a href="https://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12321632&sorter/field=issuekey&sorter/order=DESC&status=1&status=3&status=4">Search existing open bugs</a>.
If you find your issue listed then please add a comment with your details.</li>
@@ -73,16 +74,15 @@ limitations under the License.
<li>Submit either a <a href="https://issues.apache.org/jira/secure/CreateIssueDetails!init.jspa?pid=12321632&issuetype=1&priority=4&assignee=-1">bug report</a>
or <a href="https://issues.apache.org/jira/secure/CreateIssueDetails!init.jspa?pid=12321632&issuetype=4&priority=4&assignee=-1">enhancement request</a>.</li>
</ol>
- </p>
<p>
Please also remember these points:
+ </p>
<ul>
<li>the more information you provide, the better we can help you</li>
<li>test cases are vital, particularly for any proposed enhancements</li>
<li>the developers of Apache Commons Statistics are all unpaid volunteers</li>
</ul>
- </p>
<p>
For more information on git and creating patches see the
@@ -91,12 +91,12 @@ limitations under the License.
<p>
You may also find these links useful:
+ </p>
<ul>
<li><a href="https://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12321632&sorter/field=issuekey&sorter/order=DESC&status=1&status=3&status=4">All Open Apache Commons Statistics bugs</a></li>
<li><a href="https://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12321632&sorter/field=issuekey&sorter/order=DESC&status=5&status=6">All Resolved Apache Commons Statistics bugs</a></li>
<li><a href="https://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12321632&sorter/field=issuekey&sorter/order=DESC">All Apache Commons Statistics bugs</a></li>
</ul>
- </p>
</section>
</body>
</document>
[commons-statistics] 02/02: Use https link
Posted by ah...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
aherbert pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-statistics.git
commit 6f7e015d972b1a21e18cef9be3c9b3b0ae4675d6
Author: aherbert <ah...@apache.org>
AuthorDate: Tue Apr 12 11:43:01 2022 +0100
Use https link
---
src/site/xdoc/developers.xml | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/src/site/xdoc/developers.xml b/src/site/xdoc/developers.xml
index acd1722..3e7fdda 100644
--- a/src/site/xdoc/developers.xml
+++ b/src/site/xdoc/developers.xml
@@ -56,7 +56,7 @@
Like most commons components, Commons Statistics uses Apache Maven as our
build tool.
To build Commons Statistics using Maven, you can follow the instructions for
- <a href="http://maven.apache.org/run-maven/index.html">Building a
+ <a href="https://maven.apache.org/run-maven/index.html">Building a
project with Maven</a>.
Launch Maven from the top-level directory
in the checkout of Commons Statistics trunk. No special setup is required,