From 86f3d326d972c86aa463ab1cc709a9ce82cb2ff1 Mon Sep 17 00:00:00 2001 From: Beep6581 Date: Thu, 10 Aug 2017 12:53:34 +0200 Subject: [PATCH] Create CONTRIBUTING.md --- CONTRIBUTING.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..5cdfd8d5b --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,19 @@ +## Thank You +Thank you for showing interest in contributing to RawTherapee. It is people such as yourself who make this program and project possible. + +## Contribute as a Tester +The most useful feedback is based on the latest development code, and in the case of crashes should include a stack backtrace made using a debug build. +- Compilation instructions for Linux: + - http://rawpedia.rawtherapee.com/Linux +- Compilation instructions for Windows: + - http://rawpedia.rawtherapee.com/Windows +- Compilation instructions for macOS: + - http://rawpedia.rawtherapee.com/MacOS +- How to write useful bug reports including how to get stack backtraces: + - http://rawpedia.rawtherapee.com/How_to_write_useful_bug_reports + +## Contributing as a Programmer +- Announce and discuss your plans in GitHub before starting work. +- Keep branches small so that completed and working features can be merged into the "dev" branch often, and so that they can be abandoned if they head in the wrong direction. +- Use C++11 +- Code must be run through astyle version 3 or newer before being merged.