Skip to content

Commit

Permalink
JAMES-1844 Cleaning Contributing Page
Browse files Browse the repository at this point in the history
  • Loading branch information
@Laura-Royet @chibenwa
Laura-Royet authored and chibenwa committed May 3, 2017
1 parent 9a5d45f commit 3afabfe
Showing 1 changed file with 57 additions and 75 deletions.
132 changes: 57 additions & 75 deletions src/site/xdoc/contribute.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -39,113 +39,95 @@
<br />
</p>
<p>
If you are new to this you may be interested in some of these
resources.
To keep you informed on James issues, subscribe to the relevant
<a href="https://james.apache.org/mail.html">mailing lists</a>
<br />
<a href="http://jakarta.apache.org/site/guidelines.html">A good, full, summary of links to guidelines</a>
</p>
</section>

<section name="Reporting Bugs">
<p>
Many improvements come as a direct result of bug reports.
<br />
To report a bug, please use the appropriate Bug Tracker JIRA link according
to the project you want to address:
<br />
<a href="https://issues.apache.org/jira/browse/JAMES">Server</a>
<br />
<a href="https://issues.apache.org/jira/browse/MAILET">Mailet</a>
<br />
<a href="https://issues.apache.org/jira/browse/MAILBOX">Mailbox</a>
<br />
<a href="https://issues.apache.org/jira/browse/PROTOCOLS">Protocols</a>
<br />
<a href="https://issues.apache.org/jira/browse/MPT">MPT</a>
<br />
Subscribe to the relevant mailing lists (link on the left).
<a href="https://issues.apache.org/jira/browse/MIME4J">Mime4j</a>
<br />
<a href="https://issues.apache.org/jira/browse/JSIEVE">jSieve</a>
<br />
<a href="https://issues.apache.org/jira/browse/JSPF">jSPF</a>
<br />
<a href="https://issues.apache.org/jira/browse/JDKIM">jDKIM</a>
<br />
<a href="https://issues.apache.org/jira/browse/HUPA">Hupa</a>
<br />
Once you are logged on the appropriate JIRA page,
click on the red Create button, then complete the
different fields as accurately as possible, so that
any user can reproduce the reported bug.
Also note that all your information must be readable
(use markedown).
<br />
Then, you have to click on Create to submit your bug.
</p>
</section>

<section name="How to contribute to the code?">
<p>
Clone the source code of the project from its
<a href="https://github.com/apache/james-project">Github</a>
or its <a href="git://git.apache.org/james-project.git">apache git repository</a>
<br />
<a href="http://jakarta.apache.org/site/contributing.html">Craig R. McClanahan's advice how to get involved</a>
Create your branch and name it with the JIRA ticket number.
Create a Pull Request with your branch name
and prefix its different commits with the same name.
<br />
</p>
</section>

<section name="Code Patches">
<p>
Patches should be submitted to the developers mailing list.
Patches should be attached to the corresponding JIRA issue.
<br />
<b>Always</b>
use diff -u to generate patches, so we can apply them using
'patch'.
<br />
<!--
// Update this for SVN
Make sure you are patching the latest cvs (the HEAD).
(You might
want to try 'cvs diff -u -w -b -rHEAD' against the checked out
module where
you have implemented the patch.
<br />
-->

<br />
Make sure the patch only contains what is intended, your
checkout could be outdated.
<br />
Make your patch from the jakarta-james directory and make sure
it conforms
to the code standards, otherwise it may be ignored. It is OK to make a
Make sure it conforms to the code standards, otherwise it may be ignored. It is OK to make a
single patch covering several
files, but please only one issue at a time.
<br />
Prefix the mail subject with [PATCH]
<br />
Briefly outline the reason for your patch,
the solution your patch implements, why a patch is
needed and why your code will solve the problem. Note any bug numbers your
patch addresses.
<br />
Submit the patch as an attachment to the mail, this
mail should
preferably be in either BASE64 or QuotedPrintable format, to
prevent line wrapping.
<br />
</p>

<p>
The reason for these rules is so that commiters can easily see
what you are trying to achieve,
it is their resonsibility to manage the code and review submissions,
it is their responsibility to manage the code and review submissions,
if you make it easy for them to see what you are doing your
patch is more likely to
be commited quickly (or at all).
<br />
</p>
</section>

<section name="Adding New Code">
<p>
Like the principles for patch submission, mark your mail [PATCH]
and ensure
your submission conforms to the code standards. Provide a Brief outline
of
your intentions, as above, so that your code can be reviewed easily, and
a
note of any relevant bug numbers.
<br />
New files must contain a reference to the Apache licence, copy
the header from an existing file.
<br />
It also helps if you send your files in an archive (tar, zip)
which preserves directories, make it from the jakarta-james
directory so we can un-tar your files into the right place.
</p>
</section>

<section name="Reporting and Fixing Bugs">
<p>
Many improvements come as a direct result of bug
reports, and contributed fixes, often by the same person. It is sometimes
said that Apache
projects evolve because users become so fed-up waiting for bugs to be
addressed that they
fix them themselves. :)
<br />
If you report a bug,
<a href="http://issues.apache.org/jira">here</a>
we'd appreciate it if you could send a mail to the users or
developers
mailing lists, so that we can discuss it with you, bugzilla isn't a great
way for mediating
communication.
be commited quickly.
<br />
If you want to fix a bug, please contribute your changes
according to the guidelines above,
in the Code Patches section. It is much simpler to deal with
submissions if they all come
through the same channel. If you still really want to attach patches to bug
submissions, please do send us a mail tagged [PATCH] too, so
that we notice your patch.
</p>
</section>

Expand Down Expand Up @@ -181,10 +163,10 @@
maintained
with the automated build. Once a build is done, the documentation can be
further committed in the
<a href="https://svn.apache.org/repos/asf/james/site/trunk">
<a href="https://git-wip-us.apache.org/repos/asf/james-site.git">
site module
</a>
which will be automatically published via svnpubsub
which will be automatically published via gitpubsub
to
<a href="http://james.apache.org">Apache James web site</a>
.
Expand Down

0 comments on commit 3afabfe

Please sign in to comment.