Anonymous avatar Anonymous committed 0346c6d

contributing.txt: updated

Comments (0)

Files changed (1)

docs/contributing.txt

 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.
+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?
 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.
+You are welcome to send your patches to `rope-dev (at)
+googlegroups.com`_ mailing list.  Here is only a list of suggestions.
 
 Issues
 ------
 Write Plugins For Other IDEs
 ----------------------------
 
-See ropemacs_ and ropeide_.
+See ropemacs_, ropevim_, eric_ and ropeide_.
 
 
 .. _ropemacs: http://rope.sf.net/ropemacs.html
+.. _ropevim: http://rope.sf.net/ropevim.html
 .. _ropeide: http://rope.sf.net/ropeide.html
+.. _eric4: http://www.die-offenbachs.de/eric/index.html
 
 
 Rope Structure
 ==============
 
-Rope package structure::
+Rope package structure:
 
-  rope
-    base
-    refactor
-    contrib
+* `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 packages for finding their
-description.  Also have a look at `library.txt`_ for a few
-examples.
+Have a look at ``__init__.py`` of these packages or `library.txt`_ for
+more information.
 
 .. _`library.txt`: library.html
 
 Submitting patches
 ==================
 
-Patches to rope's code are welcome.
+Patches are welcome.
 
 Patch style
 -----------
 * 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
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.