Skip to content

Contributing to Surveyor

Adam Mashinchi edited this page Aug 19, 2021 · 2 revisions

We welcome all types of contributions to Surveyor.

New pull requests

To submit a new pull request, follow these steps:

  1. Fork the Surveyor repository and open a new Git branch.
  2. Commit changes locally and push them with git push -u origin $(git branch |grep '*'|cut -f2 -d' ').
  3. Open a pull request on GitHub.

Changes to definition files

Whenever possible, update an existing definition file that fits the appropriate processes for what you would like to add. In the event that there is no overlap and it requires a new definition file, make sure that it’s as complete as possible. Whenever adding process groupings to a definition file, ensure that it isn't already in an existing definition file. Whenever adding process groupings to an existing definition file or a new definition file, ensure that you have captured all the variations of the process.

New features

Ensure that the feature has been thoroughly tested and works across the supported EDR platforms. Limit use of external Python libraries. Must be Python 3 compatible.