summaryrefslogtreecommitdiffstats
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
author‏ <pascal@wagler-hannover.de>2019-06-16 20:15:06 +0000
committerPatrick Storz <eduard.braun2@gmx.de>2019-06-16 20:15:06 +0000
commitaed1f3950aee1db8dd372e22c86cc4b3303b0011 (patch)
tree367951a76a02986ac8c2a442cf50ceceeaa279d9 /CONTRIBUTING.md
parentAdd bash syntax on `INSTALL.md` (diff)
downloadinkscape-aed1f3950aee1db8dd372e22c86cc4b3303b0011.tar.gz
inkscape-aed1f3950aee1db8dd372e22c86cc4b3303b0011.zip
Corrected a few spelling and formatting errors in the markdown files.
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md41
1 files changed, 23 insertions, 18 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 73460db77..cfb50a79c 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,15 +1,16 @@
Contributing to Inkscape
========================
+
Inkscape welcomes your contributions to help turn it into a fully
-SVG-compliant drawing program for the Open Source community.
+SVG-compliant drawing program for the Open Source community.
While many developers work on fixing bugs and creating new features, it
is worth strong emphasis that even non-programmers can help make
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:
+can help:
- * Pick a bug, fix it, and send in a merge request on gitlab.
+ * 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.
@@ -21,43 +22,47 @@ can help:
GIT Access
-==========
-Inkscape is currently developed on git, with the code hosted on gitlab.
+----------
+
+Inkscape is currently developed on git, with the code hosted on GitLab.
* https://gitlab.com/inkscape/inkscape
We give write access out to people with proven interest in helping develop
-the codebase. Proving your interest is straightforward: Make two
+the codebase. Proving your interest is straightforward: Make two
contributions and request access.
Compiling the development version
-=================================
+---------------------------------
+
See http://wiki.inkscape.org/wiki/index.php/CompilingInkscape for general
remarks about compiling, including how to find some of the needed packages for
your distribution, and suggestions for developers.
Patch Decisions
-===============
+---------------
+
Our motto for changes to the codebase is "Patch first, ask questions
-later". When someone has an idea, rather than endlessly debating it, we
+later". When someone has an idea, rather than endlessly debating it, we
encourage folks to go ahead and code something up (even prototypish).
This is then incorporated into the development branch of the code for
-folks to try out, poke and prod, and tinker with. We figure, the best
+folks to try out, poke and prod, and tinker with. We figure, the best
way to see if an idea fits is to try it on for size.
Coding Style
-============
+------------
+
Please refer to the Coding Style Guidelines
(https://inkscape.org/en/develop/coding-style/) if you have specific questions
-on the style to use for code. If reading style guidelines doesn't interest
+on the style to use for code. If reading style guidelines doesn't interest
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
@@ -65,7 +70,7 @@ purpose of the code inside the file.
Building
-========
+--------
This is the best set of instructions for setting up your build directory...
@@ -74,7 +79,7 @@ You should install ninja and ccache for the fastest build:
```bash
sudo apt-get install ninja-build ccache
```
-
+
Next we prepare a build directory with a symlink to Inkscape's share folder, add a profile dir and set the bin folder (optional):
```bash
@@ -96,14 +101,14 @@ Invoke ninja to build the code. You may also use plain gcc's `make` if you didn'
ninja
```
-Now we can run inkscape that we have built, with the latest resources and code:
+Now we can run `inkscape` that we have built, with the latest resources and code:
```bash
./bin/inkscape
```
-
+
Testing
-=======
+-------
Before landing a patch, the unit tests should pass.