Update CONTRIBUTING.md
This commit is contained in:
+21
-4
@@ -1,12 +1,29 @@
|
|||||||
# Contributing to Olive
|
# 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)
|
* Indentation is 2 spaces wide, spaces only (no tabs)
|
||||||
* `lowercase_underscored_variable_names`
|
* `lowercase_underscored_variable_names`
|
||||||
* `lowercase_underscored_functions()` or `SentenceCaseFunctions()`
|
* `lowercase_underscored_functions()` or `SentenceCaseFunctions()`
|
||||||
|
|||||||
Reference in New Issue
Block a user