Skip to content

Latest commit

 

History

History
38 lines (28 loc) · 1.99 KB

CONTRIBUTING.md

File metadata and controls

38 lines (28 loc) · 1.99 KB

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. 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, and conforms with the Plaso style guide. 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 so that we can track progress, and discuss any broader ramifications.

Pull request template

Pull requests use the pull request template, which includes a checklist. When you create a pull request in the GitHub web interface the template is filled in automatically. When you create a pull request programmatically, for example with gh pr create --body, the GitHub API or an AI agent, the template is not applied. Look it up in .github/PULL_REQUEST_TEMPLATE.md and use it for the pull request description.

Getting started