The following provides instructions on how to set up your dev environment so you can start contributing to the Apache Metron project quickly.
The below instructions is with the IntelliJ as the IDE. However, you can use whatever IDE you would like to contribute to Metron.
Pre-Requisites
- Create an account on Githhub if you don't already have an account.
- Download the latest version of IntelliJ
Setting up your Dev Env
The below provides instructions on how to setup your Dev environment with Github and IntelliJ
Fork the Metron Repo
We need to first fork the Apache Metron repo. Forking a repository allows you to freely experiment with changes without affecting the original project. See here for details on forking.
The below provides instructions on how to fork the Metron Repo:
- Log into your github account
- Go to https://github.com/apache/incubator-metron and click the Fork button and fork into your github account.
- You should now have a fork like: https://github.com/[github_user_name]/incubator-metron
-
Clone the Metron repo to you local Dev Env
After forking, clone the repo to your local dev workstation. See following instructions:
- Start IntelliJ
- Click File --> New --> Project from Version Control --> Github
- Configure the Github Repo URL that you forked earlier to clone.
Setup your Cloned Repo as an IntelliJ project
- After the project has has been setup, you should see a prompt to add the cloned repo as a maven project. Click the "Add as Maven Project"
- Setup the Java SDK as 1.8
- File -> Project Structure --> Project Settings --> Project --> Select 1.8 as SDK
- Setup the Project Structure correctly
- Go to File --> Project Structure --> Project Settings --> Module
- select plus sign and select "Import Module"
- Go to the location where you cloned your fork on your local workstation and select the metron-streaming folder
- Check the checkbox "Import module as from External Folder" and Select Maven
How to Start Contributing