forked from I2P_Developers/i2p.www
Dev guide updates for git
This commit is contained in:
@@ -1,6 +1,6 @@
|
||||
{% extends "global/layout.html" %}
|
||||
{% block title %}{{ _('Developer Guidelines and Coding Style') }}{% endblock %}
|
||||
{% block lastupdated %}2020-05{% endblock %}
|
||||
{% block lastupdated %}2021-01{% endblock %}
|
||||
{% block content %}
|
||||
<p>{% trans newdevs=site_url('get-involved/guides/new-developers') -%}
|
||||
Read the <a href="{{ newdevs }}">new developers guide</a> first.
|
||||
@@ -75,19 +75,19 @@ Hours before release: Code review deadline.
|
||||
|
||||
|
||||
|
||||
<h3>Monotone</h3>
|
||||
<h3>Git</h3>
|
||||
<ul>
|
||||
<li>{% trans -%}
|
||||
Have a basic understanding of distributed source control systems, even if you haven't
|
||||
used monotone before. Ask for help if you need it.
|
||||
used git before. Ask for help if you need it.
|
||||
Once pushed, checkins are forever, there is no undo. Please be careful.
|
||||
If you have not used monotone before, start with baby steps.
|
||||
If you have not used git before, start with baby steps.
|
||||
Check in some small changes and see how it goes.
|
||||
{%- endtrans %}</li>
|
||||
<li>{% trans -%}
|
||||
Test your changes before checking them in.
|
||||
If you prefer the checkin-before-test development model,
|
||||
use your own development branch (e.g. i2p.i2p.yourname.test)
|
||||
use your own development branch
|
||||
and propagate back to i2p.i2p once it is working well.
|
||||
Do not break the build. Do not cause regressions.
|
||||
In case you do (it happens), please do not vanish for a long period after
|
||||
@@ -99,20 +99,13 @@ to know whether your change was tested or not, add a checkin comment to history.
|
||||
and increment the build revision in RouterVersion.java.
|
||||
{%- endtrans %}</li>
|
||||
<li>{% trans -%}
|
||||
Ensure that you have the latest monotonerc file in _MTN.
|
||||
Do not check in on top of untrusted revisions.
|
||||
{%- endtrans %}</li>
|
||||
<li>{% trans -%}
|
||||
Ensure that you 'mtn pull' and 'mtn update' to the latest revision before you check in and push.
|
||||
Ensure that you 'git pull' to the latest revision before you check in and push.
|
||||
If you inadvertently diverge, merge and push as soon as possible.
|
||||
Don't routinely make others merge for you.
|
||||
Yes, we know that monotone says you should push and then merge,
|
||||
but in our experience, in-workspace merge works just as well as in-database merge,
|
||||
without creating a merge revision.
|
||||
{%- endtrans %}</li>
|
||||
<li>{% trans -%}
|
||||
Do not check in major changes into the main i2p.i2p branch late in the release cycle.
|
||||
If a project will take you more than a couple days, create your own branch in monotone
|
||||
If a project will take you more than a couple days, create your own branch in git
|
||||
and do the development there so you do not block releases.
|
||||
{%- endtrans %}</li>
|
||||
</ul>
|
||||
|
@@ -1,5 +1,6 @@
|
||||
{% extends "global/layout.html" %}
|
||||
{% block title %}{% trans %}Monotone Guide{% endtrans %}{% endblock %}
|
||||
{% block lastupdated %}2021-01{% endblock %}
|
||||
{% block content_nav %}
|
||||
<ol>
|
||||
<li>
|
||||
@@ -28,6 +29,8 @@
|
||||
{% endblock %}
|
||||
|
||||
{% block content %}
|
||||
<p><b>Note:</b> We are no longer using monotone. The project has migrated all source repos to git.</p>
|
||||
|
||||
<p><i>
|
||||
{% trans transitionguide=site_url('misc/transition-guide'), newdevs=site_url('get-involved/guides/new-developers') -%}
|
||||
This is a revised version of <a href="{{ transitionguide }}">Complication's original
|
||||
|
@@ -1,13 +1,13 @@
|
||||
{% extends "global/layout.html" %}
|
||||
{% block title %}{% trans %}New Developer's Guide{% endtrans %}{% endblock %}
|
||||
{% block lastupdated %}{% trans %}July 2018{% endtrans %}{% endblock %}
|
||||
{% block lastupdated %}2021-01{% endblock %}
|
||||
{% block content_nav %}
|
||||
<ol>
|
||||
<li><a href="#basic-study">{% trans %}Basic study{% endtrans %}</a></li>
|
||||
<li><a href="#getting-the-i2p-code">{% trans %}Getting the I2P code{% endtrans %}</a>
|
||||
<ul>
|
||||
<li><a href="#git">{% trans %}The easy way: Git{% endtrans %}</a></li>
|
||||
<li><a href="#monotone">{% trans %}The proper way: Monotone{% endtrans %}</a></li>
|
||||
<li><a href="#git">{% trans %}The new way: Git{% endtrans %}</a></li>
|
||||
<li><a href="#monotone">{% trans %}The old way: Monotone{% endtrans %}</a></li>
|
||||
</ul></li>
|
||||
<li><a href="#building-i2p">{% trans %}Building I2P{% endtrans %}</a></li>
|
||||
<li><a href="#development-ideas">{% trans %}Development ideas{% endtrans %}</a></li>
|
||||
@@ -70,7 +70,8 @@ tracker</a>. We can accept GitHub pull requests, but they must be processed
|
||||
manually by turning them into patches anyway.
|
||||
{%- endtrans %}</p>
|
||||
|
||||
<h3 id="monotone">{% trans %}The proper way: Monotone{% endtrans %}</h3>
|
||||
<h3 id="monotone">{% trans %}The old way: Monotone{% endtrans %}</h3>
|
||||
<p><b>Note:</b> We are no longer using monotone. The project has migrated all source repos to git.</p>
|
||||
<ul>
|
||||
<li>{% trans -%}
|
||||
Install <a href="http://www.monotone.ca/">monotone</a>.
|
||||
@@ -170,6 +171,7 @@ commit privilege requirements. You need these to put code into i2p.i2p (not requ
|
||||
{%- endtrans %}</p>
|
||||
|
||||
<p>{% trans %}Short version of how to generate and use keys if you plan to commit:{% endtrans %}
|
||||
<b>Note:</b> No longer required. We are no longer using monotone. The project has migrated all source repos to git.
|
||||
<ul>
|
||||
<li>mtn genkey yourname-transport@mail.i2p <i>({% trans %}use an empty passphrase{% endtrans %})</i>
|
||||
<li>mtn genkey yourname@mail.i2p <i>({% trans %}enter a passphrase{% endtrans %})</i>
|
||||
|
Reference in New Issue
Block a user