diff options
| author | Tavmjong Bah <tavmjong@free.fr> | 2018-03-28 17:26:04 +0000 |
|---|---|---|
| committer | Tavmjong Bah <tavmjong@free.fr> | 2018-03-28 17:33:52 +0000 |
| commit | 3280e73763bf105871a0d1c46f3b44c76d6d3ab4 (patch) | |
| tree | 1047190c44fca144d7ca9eb3ab3747d2ae94e62d /doc/HACKING.txt | |
| parent | Add Cmd as an alternative keyboard shortcut (diff) | |
| download | inkscape-3280e73763bf105871a0d1c46f3b44c76d6d3ab4.tar.gz inkscape-3280e73763bf105871a0d1c46f3b44c76d6d3ab4.zip | |
Update HACKING.txt. Move to top directory.
Diffstat (limited to '')
| -rw-r--r-- | HACKING.txt (renamed from doc/HACKING.txt) | 32 |
1 files changed, 24 insertions, 8 deletions
diff --git a/doc/HACKING.txt b/HACKING.txt index f0856f378..93b61a294 100644 --- a/doc/HACKING.txt +++ b/HACKING.txt @@ -9,15 +9,15 @@ Inkscape more powerful and successful. You probably already have an idea of something you'd like to work on. If not, here are just a few ways you can help: - * Pick a bug, fix it, and send in a merge request on gitlab - * Choose a feature you want to see developed, and make it + * Pick a bug, fix it, and send in a merge request on gitlab. + * Choose a feature you want to see developed, and make it. * If you speak a language in addition to English, work on your - language's i18n file in the po/ directory - * Find a new bug and report it - * Help answer questions for new Inkscapers on Jabber, IRC or the - mailing lists - * Write an article advocating Inkscape - * Author a HOWTO describing a trick or technique you've figured out + language's i18n file in the po/ directory. + * Find a new bug and report it. + * Help answer questions for new Inkscapers on IRC, forum, or the + mailing lists. + * Write an article advocating Inkscape. + * Author a HOWTO describing a trick or technique you've figured out. GIT Access @@ -56,6 +56,14 @@ you, just follow the general style of the surrounding code, so that it is at least consistent. +Documentation +============= + +Code needs to be documented. Future Inkscape developers will really +appreciate this. New files should have one or two lines describing the +purpose of the code inside the file. + + Makefiles ========= Inkscape currently uses CMake. We encourage you to build it by creating a build @@ -73,3 +81,11 @@ This uses ccache to speed up later builds (optional), create a Debug build (If you have ninja available, add "-G Ninja" to enable it) Then, run `make -j$(nproc) install` (or `ninja install`) to build & install + + +Testing +======= + +Before landing a patch, the unit tests should pass. + +See: http://wiki.inkscape.org/wiki/index.php/CMake#Using_CMake_to_run_tests |