Skip to content

Latest commit

 

History

History
107 lines (70 loc) · 2.57 KB

contributing.rst

File metadata and controls

107 lines (70 loc) · 2.57 KB
Raw

Contributing to Rope

Getting Involved!

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

How to Help Rope?

Rope's mailing list is rope-dev (at) googlegroups.com. Click the "Join group to post" button to subscribe. Then:

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

Wish List

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

Issues

The dev/issues.rst 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://bitbucket.org/agr/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.rst for more information.

Source Repository

Rope uses GitHub. The repository exists at `https://github.com/python-rope/rope`_.

Submitting patches

Patches are welcome.

Programming Style

  • Follow PEP 8.
  • Use four spaces for indentation.
  • Include good unit-tests when appropriate.
  • Rope test suite should pass after patching

Sending Patches

Follow the instructions on GitHub on how to setup Git and fork the python-rope/rope repository. Once your changes are ready, send a pull request for review.