Skip to content

Latest commit

 

History

History
55 lines (40 loc) · 2.57 KB

CONTRIBUTING.md

File metadata and controls

55 lines (40 loc) · 2.57 KB

Contributing to DepthAI Nodes

It outlines our workflow and standards for contributing to this project.

Table of Contents

Developing parser

Parser should be developed so that it is consistent with other parsers. Check out other parsers to see the required structure. Additionally, pay attention to the naming of the parser's attributes. Check out Developer guide.

Pre-commit Hooks

We use pre-commit hooks to ensure code quality and consistency:

  1. Install pre-commit (see pre-commit.com).
  2. Clone the repository and run pre-commit install in the root directory.
  3. The pre-commit hook will now run automatically on git commit.
    • If the hook fails, it will print an error message and abort the commit.
    • It will also modify the files in-place to fix any issues it can.

Documentation

We use the Epytext markup language for documentation. To verify that your documentation is formatted correctly, follow these steps:

  1. Download get-docs.py script
  2. Run python3 get-docs.py luxonis_ml in the root directory.
    • If the script runs successfully and produces docs.json file, your documentation is formatted correctly.
    • NOTE: If the script fails, it might not give the specific error message. In that case, you can run the script for each file individually until you find the one that is causing the error.

Editor Support

  • PyCharm - built in support for generating epytext docstrings
  • Visual Studie Code - AI Docify extension offers support for epytext
  • NeoVim - vim-python-docstring supports epytext style

Making and Reviewing Changes

  1. Make changes in a new branch.
  2. Test your changes locally.
  3. Commit (pre-commit hook will run).
  4. Push to your branch and create a pull request. Always request a review from:
  5. Any other relevant team members can be added as reviewers as well.
  6. The team will review and merge your PR.