rope-qickfix / docs / contributing.txt

 Contributing to Rope

Get Involved!

Rope was started because of the lack of good refactoring tools for
python.  But after observing python IDE limitations we grew bigger
ideas in our heads.

If you want to have a more powerful python IDE and have big ideas
in your head, you are welcome to get involved.

How to Help Rope?

Rope mailing list:  `rope-dev (at)`_

* Use rope
* Send bugs reports and request features
* Submit patches for bugs or new features
* Discuss your ideas

.. _`rope-dev (at)`:

Wish List

If you're interested you are welcome to discuss your ideas in
`rope-dev (at)`_ mailing list or send your patches.
Here is only a list of suggestions.

Getting Ready For Python 3.0

Checkout Mercurial_
repository.  Contributions are welcome.

Enhance ropemacs

Ropemacs_ can be enhanced very much and many of rope's features can be
added to it.  Any help is welcome.

.. _ropemacs:

Write Plugins For Other IDEs

See ropemacs_ and Ropeide_.

.. _ropeide:


You can format python source code.  This probably needs using ASTs and
writing them.

Detecting Warnings

This might include detecting unused variables and imports or
unreachable statements.  `rope.base` can help, too.  Currently rope
detects things like redefined elements and assignment to self.

Modules Without Source Code

Rope cannot know anything about python C extensions and modules
without matching source code.  Some information can be gathered using
`inspect` module.  But it's not safe; Yet better than nothing.  This
requires a good knowledge of `rope.base`.

Rope Structure

Rope package structure::


Have a look at ```` of packages for finding their
description.  Also have a look at `library.txt`_ for a few

.. _`library.txt`: library.html

Source Repository

Rope uses Mercurial_ CMS:

* Rope main branch:
* Rope py3k branch:

Submitting patches

Patches to rope's code are welcome.

Patch style

* Follow :PEP:`8`.
* Use four spaces for indentation.
* Include good unit-tests if possible.
* Rope test suite should pass after patching (``python``).

.. _Mercurial: