Contributing to Rope

Get Involved!

Rope's main goal is being a good refactoring tool for python. It also provides some IDE helpers. If you like to contribute, you're welcome!

How to Help Rope?

Rope mailing list is rope-dev (at) googlegroups.com. You can send a mail to rope-dev-subscribe (at) googlegroups [dot] com to subscribe.

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

Wish List

You are welcome to send your patches to rope-dev (at) googlegroups.com mailing list. Here is only a list of suggestions.

Issues

The dev/issues.txt file is actually the main rope todo file. There is a section called "unresolved issues"; it contains almost every kind of task. Most of them need some thought or discussion. Pickup whichever you are most interested in. If you have ideas or questions about them, don't hesitate to discuss it in the mailing list.

Getting Ready For Python 3.0

Checkout http://rope.sf.net/hg/rope_py3k Mercurial repository. Contributions are welcome.

Write Plugins For Other IDEs

See ropemacs, ropevim, eric4 and ropeide.

Rope Structure

Rope package structure:

rope.base: the base part of rope
rope.refactor: refactorings and tools used in them
rope.contrib: IDE helpers

Have a look at __init__.py of these packages or library.txt for more information.

Source Repository

Rope uses Mercurial CMS:

Rope main branch: http://rope.sourceforge.net/hg/rope
Rope py3k branch: http://rope.sourceforge.net/hg/rope_py3k

Submitting patches

Patches 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
Use hg export format to preserve your identity