rope / 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) googlegroups.com`_

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

.. _`rope-dev (at) googlegroups.com`: http://groups.google.com/group/rope-dev


Wish List
=========

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

Getting Ready For Python 3.0
----------------------------

Checkout http://rope.sourceforge.net/hg/rope_py3k 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: http://rope.sf.net/ropemacs.html

Write Plugins For Other IDEs
----------------------------

See ropemacs_ and Ropeide_.


.. _ropeide: http://rope.sf.net/ropeide.html


Formatting
----------

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::

  rope
    base
    refactor
    contrib

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

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


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 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 runtests.py``).

.. _Mercurial: http://selenic.com/mercurial
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.