mirror of
https://github.com/evennia/evennia.git
synced 2026-03-18 13:56:30 +01:00
93 lines
4.2 KiB
ReStructuredText
93 lines
4.2 KiB
ReStructuredText
Contributing to Evennia
|
|
=======================
|
|
|
|
Wanna help out? Great! Here's how.
|
|
|
|
Contributing with Documentation
|
|
-------------------------------
|
|
|
|
Evennia depends heavily on good documentation and we are always looking
|
|
for extra eyes and hands to improve it. Even small things such as fixing
|
|
typos are a great help!
|
|
|
|
The documentation is a wiki and to edit it you need wiki-contributor
|
|
access. We are happy to give this - just ask (on the forum/mailing list
|
|
or in the chat channel) if you want to help out. Otherwise, it goes a
|
|
long way just pointing out wiki errors so devs can fix them (in an Issue
|
|
or just over chat/forum). You can also commit wiki changes over
|
|
Mercurial - just go to the wiki repository
|
|
`here <http://code.google.com/p/evennia/source/checkout?repo=wiki>`_ and
|
|
then continue from point ``2`` below.
|
|
|
|
Contributing with Code through a clone repository
|
|
-------------------------------------------------
|
|
|
|
We always need more eyes and hands on the code. Even if you don't feel
|
|
confident with tackling any major bugs or features, just correcting
|
|
typos, adjusting formatting or simply using the thing helps us a lot in
|
|
improving things.
|
|
|
|
The most elegant way to contribute code to Evennia is to use Mercurial
|
|
to create an online *clone* of the Evennia repository and make your
|
|
changes to that. Here's how to create your own clone (you only need to
|
|
do this once):
|
|
|
|
#. Go to the
|
|
`Checkout <http://code.google.com/p/evennia/source/checkout>`_ page.
|
|
#. If you are logged in, you should see a button named *Create a Clone*.
|
|
Click that.
|
|
#. You are asked to fill in a few fields. Name your clone repository
|
|
something useful, like "Johns-evennia-fixes". Give a brief summary,
|
|
like "my repo for contributing to Evennia". Accept.
|
|
#. Your new repo is created. You should see it appear in the `clone-repo
|
|
list <https://code.google.com/p/evennia/source/clones>`_. This is
|
|
actually your own mini-version of the Evennia page!
|
|
#. Choose your repo and you will find it has its own Checkout page. Use
|
|
the command shown there to get a local copy of your clone to your
|
|
computer.
|
|
|
|
Once you have an online clone and a local copy of it:
|
|
|
|
#. Code away on your computer, fixing bugs or whatnot (you can be
|
|
offline for this). Commit your code to your local clone as you work,
|
|
as often as you like. There are some suggestions for setting up a
|
|
sane local work environment with Mercurial
|
|
`here <http://code.google.com/p/evennia/wiki/VersionControl>`_.
|
|
#. When you have something you feel is worthwhile (or just want to ask
|
|
people's opinions or make an online backup), *push* your local code
|
|
up to your online repository with Mercurial.
|
|
#. Let people know what you did - talk and discuss. If you think your
|
|
changes should be merged into main Evennia (maybe you have made
|
|
bugfixes, added new features etc), make a new
|
|
`Issue <http://code.google.com/p/evennia/issues/list>`_ using the
|
|
"Merge Request" template. Try to separate features with different
|
|
commits, so it's possible to pick individual features.
|
|
|
|
From your online repo, Evennia devs can then, assuming the change is
|
|
deemed good, pick and merge your work into Evennia proper. Mercurial
|
|
will automatically make sure you get proper credit for your contribution
|
|
in the source code history.
|
|
|
|
Contributing with Patches
|
|
-------------------------
|
|
|
|
To help with Evennia development it's recommended to do so using a clone
|
|
repository as described above. But for small, well isolated fixes you
|
|
are also welcome to submit your suggested Evennia fixes/addendums as
|
|
*patches*. You can use `normal
|
|
patches <https://secure.wikimedia.org/wikipedia/en/wiki/Patch_%28computing%29>`_,
|
|
but it might be easier to use mercurial's own patch mechanism. Make sure
|
|
you have committed your latest fixes first, then
|
|
|
|
::
|
|
|
|
hg export tip > mypatch.patch
|
|
|
|
This will create a patch file ``mypatch.patch`` that can be imported by
|
|
others with ``hg import mypatch.patch``. Depending on what fits best,
|
|
post your patch to the `issue
|
|
tracker <https://code.google.com/p/evennia/issues/list>`_ or to the
|
|
`discussion forum <https://groups.google.com/forum/#!forum/evennia>`_.
|
|
Please avoid pasting the full patch text directly in your post though,
|
|
best is to use a site like `Pastebin <http://pastebin.com/>`_ and just
|
|
supply the link.
|