diff options
Diffstat (limited to 'HACKING')
| -rw-r--r-- | HACKING | 25 |
1 files changed, 20 insertions, 5 deletions
diff --git a/HACKING b/HACKING index b184150c..dd384758 100644 --- a/HACKING +++ b/HACKING @@ -10,6 +10,7 @@ Coding Style http://www.python.org/dev/peps/pep-0008/ * Although this guide suggests otherwise, tabs are used for indentation of code and docstrings. In other documents (readme, etc), use spaces. +* Test the code with unit tests where it makes sense Patches @@ -23,6 +24,20 @@ If you plan to do major changes, or many changes over time, I encourage you to create a fork on GitHub, Gitorious or any other site. +Starting Points +--------------- + +Good places to read about ranger internals are: +ranger/core/actions.py +ranger/core/environment.py +ranger/fsobject/fsobject.py + +About the UI: +ranger/gui/widgets/browsercolumn.py +ranger/gui/widgets/browserview.py +ranger/gui/defaultui.py + + Common Changes -------------- @@ -41,12 +56,13 @@ assuming <self> is a "SettingsAware" object. * Changing commands, adding aliases: ranger/defaults/commands.py +or ~/.config/ranger/commands.py * Adding colorschemes: Copy ranger/colorschemes/default.py to ranger/colorschemes/myscheme.py and modify it according to your needs. Alternatively, mimic the jungle colorscheme. It subclasses the default scheme and just modifies a few things. -In ranger/defaults/options.py (or ~/.ranger/options.py), change +In ranger/defaults/options.py (or ~/.config/ranger/options.py), change colorscheme = 'default' to: colorscheme = 'myscheme' @@ -74,7 +90,6 @@ Version Numbering X.Y.Z, where: -* X: Milestones -* Y: Stable versions -* Z: Experimental versions - +* X: Major version, milestone +* Y: Minor version, even number => stable version +* Z: Revision, may be omitted if zero |