Skip to content

Latest commit

 

History

History
55 lines (46 loc) · 2.5 KB

CONTRIBUTING.md

File metadata and controls

55 lines (46 loc) · 2.5 KB
Raw

Contributing to darktable

The darktable project welcomes contributions:

See the darktable development page for more information.

Code

Before you spend a lot of time working on a new feature, it's always best to discuss your proposed changes with us first. The best place to do that is in our IRC channel on irc.freenode.net, channel #darktable or the development mailing list, see here for more information. This will dramatically improve your chances of having your code merged, especially if we think you'll hang around to maintain it.

Coding style

We like our code to be properly formatted. We have a well-defined coding style, and .clang-format style file represents it fully. You can enforce your commits to follow it:

  1. Install clang-format clang tool. Probably, any version will be ok, but the newer the better.
  2. You'll need to integrate git and clang-format.
  • For that, you will need to download git-clang-format from here or here.
  • Read it to check for nastiness.
  • Warning: apparently, it only works with Python2, and does not work with Python3!
  • Put it somewhere in your path (e.g. ~/bin or /usr/local/bin) and ensure that it is executable (chmod +x).
  1. Now, step into your local clone of repository:
  • cd darktable/.git/hooks
  • If you previously did not have a pre-commit hook:
    • cp pre-commit.sample pre-commit && chmod +x pre-commit
  • Open pre-commit with your favourite text editor, and append before the last block, here is how the end should look:
# format everything
res=$(git clang-format --diff | wc -l)
if [ $res -ne 1 ]
then
	git clang-format
	echo "Commit did not match clang-format"
	exit 1;
fi

# If there are whitespace errors, print the offending file names and fail.
exec git diff-index --check --cached $against --