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-rng.git
commit 29cda7b7336d9089aac1779cbb349f3739fb08df
Author: Alex Herbert <aherb...@apache.org>
AuthorDate: Wed Nov 13 00:00:14 2019 +0000
Update developers guidelines.
There is no need to configure core.autocrlf as the repo uses
.gitattributes.
Use https for links if available.
Updated some expired links:
Numerical recipes
Apache CLA
Oracle Code guidelines
Removed reference to RNG wishlist. It is not available on Confluence.
---
src/site/xdoc/developers.xml | 44 +++++++++++++++-----------------------------
1 file changed, 15 insertions(+), 29 deletions(-)
diff --git a/src/site/xdoc/developers.xml b/src/site/xdoc/developers.xml
index 0378d9f..f3e3aa3 100644
--- a/src/site/xdoc/developers.xml
+++ b/src/site/xdoc/developers.xml
@@ -57,7 +57,7 @@
build tool. The sources can also be built using Ant (a working
Ant build.xml is included in the top level project directory).
To build Commons RNG 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 RNG trunk. No special setup is required,
@@ -67,11 +67,6 @@
Maven.
</li>
<li>
- Have a look at the new features that users and developers have
requested
- on the <a href="http://wiki.apache.org/commons/RngWishList";>
- RNG Wish List Wiki Page.</a>
- </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
@@ -127,13 +122,9 @@
useful</li>
</ul></li>
<li>Assuming a generally favorable response to the idea on
commons-dev,
- the next step is to add an entry to the
- <a href="http://wiki.apache.org/commons/RngWishList";>RNG Wish
- List</a> corresponding to the idea. Include a reference to the
- discussion thread. </li>
- <li>Create a JIRA ticket using the the feature title as the short
+ 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 JIRA ticket to the WishList
entry.
+ description.
</li>
<li>Submit code as attachments to the JIRA ticket. Please use one
ticket for each feature, adding multiple patches to the ticket
@@ -148,27 +139,22 @@
<subsection name='Coding Style'>
<p>
- Commons RNG follows <a href="http://java.sun.com/docs/codeconv/";>Code
+ Commons RNG follows
+ <a
href="https://www.oracle.com/technetwork/java/codeconventions-150003.pdf";>Code
Conventions for the Java Programming Language</a>. As part of the
maven
build process, style checking is performed using the Checkstyle
plugin,
using the properties specified in <code>checkstyle.xml</code>.
Committed code <i>should</i> generate no Checkstyle errors. One
thing
- that Checkstyle will complain about is tabs included in the source
code.
+ that Checkstyle will complain about is tabs included in the code
code.
Please make sure to set your IDE or editor to use spaces instead of
tabs.
</p>
<p>
- Committers should configure the <source>user.name</source>,
- <source>user.email</source> and <source>core.autocrlf</source>
- git repository or global settings with <source>git config</source>.
- The first two settings define the identity and mail of the committer.
- The third setting deals with line endings to achieve consistency
- in line endings. Windows users should configure this setting to
- <source>true</source> (thus forcing git to convert CR/LF line endings
- in the workspace while maintaining LF only line endings in the
repository)
- while OS X and Linux users should configure it to
<source>input</source>
- (thus forcing git to only strip accidental CR/LF when committing into
- the repository, but never when cheking out files from the
repository). See <a
-
href="http://www.git-scm.com/book/en/Customizing-Git-Git-Configuration";>Customizing
+ Committers should configure the git repository or global settings
for:
+ </p>
+ <source>user.name
+user.email</source>
+ <p>These settings define the identity and mail of the committer. See <a
+
href="https://www.git-scm.com/book/en/Customizing-Git-Git-Configuration";>Customizing
Git - Git Configuration</a> in the git book for explanation about
how to
configure these settings and more.
</p>
@@ -189,7 +175,7 @@
</li>
<li>
Commons RNG javadoc generation supports embedded LaTeX formulas
via the
- <a href="http://www.mathjax.org";>MathJax</a> javascript display
engine.
+ <a href="https://www.mathjax.org";>MathJax</a> javascript display
engine.
To embed mathematical expressions formatted in LaTeX in javadoc,
simply surround
the expression to be formatted with either <code>\(</code> and
<code>\)</code>
for inline formulas (or <code>\[</code> and <code>\]</code> to
have the formula
@@ -250,7 +236,7 @@
</li>
<li>
All contributions must comply with the terms of the Apache
- <a href="http://www.apache.org/licenses/cla.pdf";>Contributor
License
+ <a
href="https://www.apache.org/licenses/contributor-agreements.html";>Contributor
License
Agreement (CLA)</a>.
</li>
<li>
@@ -264,7 +250,7 @@
References to source materials covered by restrictive proprietary
licenses should be avoided. In particular, contributions should
not
implement or include references to algorithms in
- <a href="http://www.nr.com/";>Numerical Recipes (NR)</a>.
+ <a href="http://numerical.recipes/";>Numerical Recipes (NR)</a>.
Any questions about copyright or patent issues should be raised on
the commons-dev mailing list before contributing or committing
code.
</li>
