From cc777756924b488e19a4b3d71d17a67775b58a55 Mon Sep 17 00:00:00 2001 From: Simran Date: Thu, 5 Nov 2020 10:18:53 +0100 Subject: [PATCH] Update CONTRIBUTING.md --- CONTRIBUTING.md | 25 +++++++++++++++++++++---- 1 file changed, 21 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e9e35c5a9..ef3600f54 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,12 +1,29 @@ # Contributing to Olive -Thank you for your interest in contributing to Olive! In order to keep the code as readable and maintainable as possible, code submitted should abide by the following standards: +Thank you for your interest in contributing to Olive! -### Standards +## Reporting issues -When contributing to Olive, it's recommended to use the following rules: +Bug reports help to make the software more stable and usable. +Please read the pinned [issue #1175](https://github.com/olive-editor/olive/issues/1175) +for guidelines before you create a new issue. -* The code style generally follows the [Google C++ Style Guide](https://google.github.io/styleguide/cppguide.html) including, but not limited to: +## Writing code + +Code contributions are welcome. Note that the code base is rapidly changing in +the current stage of development however. There is some documentation in the form +of code comments, including Javadoc in header files. Feel free to reach out via +an issue or pull request if you have questions about the architecture or +implementation details. + +### Code Standards + +In order to keep the code as readable and maintainable as possible, code +submitted should abide by the following standards: + +* The code style generally follows the + [Google C++ Style Guide](https://google.github.io/styleguide/cppguide.html) + including, but not limited to: * Indentation is 2 spaces wide, spaces only (no tabs) * `lowercase_underscored_variable_names` * `lowercase_underscored_functions()` or `SentenceCaseFunctions()`