Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.Sign up
- Setting up and maintaining your development environment
- Getting Started
- Contributing Code
Setting up and maintaining your development environment
The first challenge you will encounter is setting up and maintaining your development environment.
Note that plaso and some dependencies are currently actively under development keeping up with the development release is not for "the faint of heart".
- Running the development release on Ubuntu Linux
- Running the development release on Fedora Core Linux
- Running the development release on Mac OS X
- Running the development release on Windows
Once you've set up your development environment we recommend start simple:
- How to write a parser
- How to write a parser plugin
- How to write an analysis plugin
- How to write an output module
Overview of the general architecture of plaso:
Want to add a parser to plaso and you are ready to go? Start by checking here if someone is already working on it. If you don't see anything there you can just go ahead and create an issue on the github site and mark it as "enhancement". Assign the issue to yourself so that we can keep track on who is working on what.
If you cannot program and still have a great idea for a feature please go ahead and create an issue and leave it unassigned, note that the priority will be who ever wants to work on it. Or consider this the idea opportunity to learn yourself Python programming.
Before you start writing the code, please review the following:
- Style guide. All code submitted to the project needs to follow this style guide.
- Code review. All code that is submitted into the project needs to be reviewed by at least one other person.
- Adding a new dependency. If your code requires adding a new dependency please check out these instructions.
Before you submit your first code review
- Join the development mailing list: email@example.com, we recommend using the same account as step 1
- Install the required development tools like pylint, python-mock, sphinx
- Make sure to run all the tests inside the plaso and the dfVFS codebase, and that they successfully complete on your development system
- Make sure your development system is set up correctly so that you can develop and test correctly.
- Make sure your email address and name are correctly set in git e.g.:
git config --global user.name "Full Name" git config --global user.email firstname.lastname@example.org git config --global push.default matching
git config -l to determine the current configuration.
Core features changes
Sometimes you need to make some change to the core of the plaso codebase. In those cases we ask that contributors first create a short design doc explaining the rationale behind the change. The design doc needs to contain:
- Describe the problem you are facing
- List the objectives of this change
- Mention what is in scope and what's not
- Describe the solution/proposal
The preferred way of creating these design docs is to use Google Docs and send the link to the development mailing list so that it can be discussed further before starting to implement the code.
The current design docs are stored here. You may not have access to that folder, so you may need to request access to it.
Tests are part of a maintainable code base. Code without sufficient test is very likely to be broken by a large rewrite/refactor.
Some guidelines for writing tests: Style guide - tests