I2P_Developers/i2p.www
3
0
Fork 5
Code Issues 27 Pull Requests Actions 1 Packages Projects Releases Wiki Activity

style guide tweaks

Browse Source
This commit is contained in:
zzz
2015-10-09 00:17:28 +00:00
parent 687f30b7c1
commit ac2a106c8e
1 changed files with 14 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
i2p2www/pages/site/get-involved/guides/dev-guidelines.html
View File

@ -1,5 +1,6 @@
{% extends "global/layout.html" %} {% extends "global/layout.html" %}
{% block title %}{{ _('Developer Guidelines and Coding Style') }}{% endblock %} {% block title %}{{ _('Developer Guidelines and Coding Style') }}{% endblock %}
{% block lastupdated %}{% trans %}October 2015{% endtrans %}{% endblock %}
{% block content %} {% block content %}
<p>{% trans newdevs=site_url('get-involved/guides/new-developers') -%} <p>{% trans newdevs=site_url('get-involved/guides/new-developers') -%}
Read the <a href="{{ newdevs }}">new developers guide</a> first. Read the <a href="{{ newdevs }}">new developers guide</a> first.
@ -102,9 +103,12 @@ translators have a chance to update before the release.
Use generics and concurrent classes where possible. I2P is a highly multi-threaded application. Use generics and concurrent classes where possible. I2P is a highly multi-threaded application.
{%- endtrans %}</li> {%- endtrans %}</li>
<li>{% trans -%} <li>{% trans -%}
We require Java 6 to build but only Java 5 to run I2P. Be familiar with common Java pitfalls that are caught by findbugs.
Do not use Java 6 classes or methods without handling the class not found exceptions Run 'ant findbugs' to learn more.
and providing alternate Java 5 code. See classes in net.i2p.util for examples. {%- endtrans %}</li>
<li>{% trans -%}
We require Java 6 to build and run I2P.
Do not use Java 7 classes or methods.
{%- endtrans %}</li> {%- endtrans %}</li>
<li>{% trans -%} <li>{% trans -%}
Explicitly convert between primitive types and classes; Explicitly convert between primitive types and classes;
@ -136,6 +140,13 @@ Monitor {{ trac }} for tickets you have been assigned or can help with.
Assign, categorize, comment on, fix, or close tickets if you can. Assign, categorize, comment on, fix, or close tickets if you can.
{%- endtrans %}</li> {%- endtrans %}</li>
<li>{% trans -%} <li>{% trans -%}
New developers should start by fixing a bug.
Search for bugs with the 'easy' keyword on trac.
When you have a fix, attach your patch to the ticket and add the keyword 'review-needed'.
Do not close the ticket until it's been successfully reviewed and you've checked your changes in.
Once you've done this smoothly for a couple of tickets, you may follow the normal procedure below.
{%- endtrans %}</li>
<li>{% trans -%}
Close a ticket when you think you've fixed it. Close a ticket when you think you've fixed it.
We don't have a test department to verify and close tickets. We don't have a test department to verify and close tickets.
If you arent sure you fixed it, close it and add a note saying If you arent sure you fixed it, close it and add a note saying