File: CONTRIBUTING.md

package info (click to toggle)
plaso 20190131-1
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 410,832 kB
  • sloc: python: 76,636; sh: 926; makefile: 167; xml: 70; sql: 14; vhdl: 11
file content (29 lines) | stat: -rw-r--r-- 1,515 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
# How to contribute

We welcome code contributions to Plaso, whether they're bug fixes, new parsers,
plugins, output modules, core improvements or anything else! To make things as
easy, reliable and maintainable as possible, we have some specific resources
and procedures you should refer to.

## Bug reports

We're also keen to hear about bugs, crashes or hangs you might experience with
Plaso. Feel free to open a [GitHub issue](https://github.com/log2timeline/plaso/issues).
We'll almost certainly ask you how you installed Plaso, and for relevant debug output,
so save us all some time, and include that first up!

## Code Review

All code for Plaso goes through [code review](https://plaso.readthedocs.io/en/latest/sources/developer/Codereview.html),
and conforms with the Plaso [style guide](https://plaso.readthedocs.io/en/latest/sources/developer/Style-guide.html).
Please don't send a pull request without creating a code review issue first!

If you're adding a new feature or have some code fix a bug, please also open a
[GitHub issue](https://github.com/log2timeline/plaso/issues) so that we can
track progress, and discuss any broader ramifications.

## Getting started

* Make sure you have a [GitHub account](https://github.com/signup/free), then create your own Plaso fork
* Join the development [mailing list](log2timeline-dev@googlegroups.com)
* Read through the [developers guide](https://plaso.readthedocs.io/en/latest/sources/developer/Developers-Guide.html) for detailed instructions and tips.