Merge pull request #11 from Shoalsteed/master

Update dev-guidelines.html
This commit is contained in:
idk
2023-05-25 17:06:41 -04:00
committed by GitHub
3 changed files with 25 additions and 27 deletions

View File

@ -1,12 +1,12 @@
<p>{% trans -%} Your web browser will need to be configured in order to browse web sites on I2P and to utilize the outproxies available within I2P. Below are walkthroughs for some of the most popular browsers. {%- endtrans %}</p>
<p>{% trans -%} A web browser will need to be configured to access sites and services on the I2P network, and to utilize outproxies. Below are walkthroughs for some of the most popular browsers. {%- endtrans %}</p>
<h2>{{ _('Firefox Profile for Windows') }}</h2>
<p>{% trans profile='/firefox' -%} If you are using Windows, the recommended way of accessing I2P is using the
<p>{% trans profile='/firefox' -%} If you are using Windows, the recommended way of accessing the I2P network is using the
<a href='{{ profile }}'>Firefox profile</a>. {%- endtrans %}</p>
<p><strong>{% trans -%} If you used the Easy-Install bundle, the Firefox profile is included and you can skip this page. {%- endtrans %}</strong></p>
<p>{% trans -%} If you do not wish to use that profile or are not on Windows, you need to configure your browser yourself. Read below on how to that. {%- endtrans %}</p>
<p>{% trans -%} If you do not wish to use that profile or are not on Windows, you will need to configure a browser. {%- endtrans %}</p>
<h2>{{ _('How to configure your browser') }}</h2>
<h2>{{ _('How To Configure Your Browser') }}</h2>
<ul>
<li><a href="#firefox">Firefox</a></li>
@ -89,13 +89,13 @@ settings and your browser is set to use the I2P proxy.
<a name="TOS"></a>
<h3>{{ _('Outproxy Terms Of Service') }}</h3>
<p>{% trans -%}
I2P is not designed for creating proxies to the Internet.
Instead, it is meant to be used as an internal network.
The I2P network is a peer-to-peer overlay network.
Proxying to the clearnet is not part of its design or function with regards to its communication protecting network features.
{%- endtrans %}</p>
<p>{% trans -%}
<p><b>The I2P project itself does not run any proxies to the Internet.</b>
<p><b>The I2P Project itself does not run any proxies to the Internet.</b>
The I2P software includes a default outproxy: exit.stormycloud.i2p.
These are run by a volunteer. </p>
These are run by StormyCloud Inc. </p>
<a href="https://stormycloud.org"
target="_blank">https://stormycloud.org</a>
{%- endtrans %}</p>
@ -109,4 +109,4 @@ not allowed via the outproxies.
<p>{% trans -%}
<a href="https://www.torproject.org">Tor</a> provides a browser to use as an outproxy to the Internet.
{%- endtrans %}</p>
<!-- vim: set noai ff=unix nosi ft=html tw=79 et sw=4 ts=4 spell spelllang=en: -->
<!-- vim: set noai ff=unix nosi ft=html tw=79 et sw=4 ts=4 spell spelllang=en: -->

View File

@ -20,7 +20,7 @@ check with the appropriate developer for guidance.
<ul>
<li>{% trans -%}
Please don't just "write code". If you can, participate in other development activities, including:
development discussions and support on IRC, zzz.i2p, and i2pforum.i2p; testing;
development discussions and support on IRC, i2pforum.i2p; testing;
bug reporting and responses; documentation; code reviews; etc.
{%- endtrans %}</li>
<li>{% trans -%}
@ -34,9 +34,9 @@ the checkin deadline for a release.
<h3>{{ _('Release Cycle') }}</h3>
<p>
Our normal release cycle is 6-12 weeks.
The normal release cycle is 6-12 weeks.
Following are the approximate deadlines within a typical 8-week cycle.
Actual deadlines for each release are set by the lead developer after consultation with the full team.
Actual deadlines for each release are set by the release manager after consultation with the full team.
</p>
<ul>
@ -151,7 +151,7 @@ Be familiar with common Java pitfalls that are caught by findbugs.
Run 'ant findbugs' to learn more.
{%- endtrans %}</li>
<li>
We require Java 8 to build and run I2P as of release 0.9.47.
Java 8 is required to build and run I2P as of release 0.9.47.
Do not use Java 7 or 8 classes or methods in embedded subsystems: addressbook, core, i2ptunnel.jar (non-UI), mstreaming, router, routerconsole (news only), streaming.
These subsystems are used by
Android and embedded applications that require only Java 6. All classes must be available in Android API 14.
@ -258,7 +258,7 @@ Only check in code that you wrote yourself.
Before checking in any code or library jars from other sources,
justify why it is necessary,
verify the license is compatible,
and obtain approval from the lead developer.
and obtain approval from the release manager.
{%- endtrans %}</li>
<li>{% trans -%}
If you do obtain approval to add external code or jars,
@ -278,19 +278,18 @@ Include the license and source information in the checkin comment.
<h3>{{ _('Bugs') }}</h3>
<ul>
<li>{% trans trac=i2pconv('trac.i2p2.i2p') -%}
Managing Trac tickets is everybody's job, please help.
Monitor {{ trac }} for tickets you have been assigned or can help with.
Assign, categorize, comment on, fix, or close tickets if you can.
Managing issues are everybody's job, please help.
Monitor {{ Gitlab }} for issues you can help with.
Comment on, fix, and close issues if you can.
{%- endtrans %}</li>
<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.
New developers should start by fixing issues.
When you have a fix, attach your patch to the issue and add the keyword 'review-needed'.
Do not close the issue 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 an issue when you think you've fixed it.
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
"I think I fixed it, please test and reopen if it's still broken".

View File

@ -1,15 +1,14 @@
{% extends "global/layout.html" %} {% block title %}{% trans %}Get Involved{% endtrans %}{% endblock %} {% block content %}
<h2>{% trans %}Contribute to the I2P Network .{% endtrans %}</h2>
<h2>{% trans %}Contribute to the I2P Network{% endtrans %}</h2>
<ul>
</li>
<li><b>{% trans %}Support I2P Core Development{% endtrans %}</b>{% trans %}The project hosts meetings on the first Tuesday of every month that are open to the community. This is a great opportunity to see what is happening with I2P core development and
familiarize yourself with Roadmap tasks. See the
new developer's guide for how to get started.{% endtrans %}
<li><b>{% trans %}Support I2P Core Development{% endtrans %}</b>{% trans %} The project hosts meetings on the first Tuesday of every month that are open to the community. This is a great opportunity to see what is happening with I2P core development and
familiarize yourself with Roadmap tasks. {% endtrans %}
</li>
<li><b><a href="{{ newtrans }}">{{ _('Translation and Documentation') }}</a></b> &mdash; {% trans newtrans=site_url('get-involved/guides/new-translators') -%} Help translate the website and the software into your language. Translators are a very important
part of this decentralized project and your work is always appreciated. See the new translator's guide for details. The project also welcomes support to help keep its documentation updated. See the <a href="{{ newtrans }}">new translator's guide</a> for details. {%- endtrans %}
part of this decentralized project and your work is always appreciated. The project also welcomes support to help keep its documentation updated. See the <a href="{{ newtrans }}">new translator's guide</a> for details. {%- endtrans %}
</li>
</ul>
<h3>{% trans %}Host Services for Yourself and Others{% endtrans %}</h3>