search

openvinotoolkit / openvino.genai

Run Generative AI models using native OpenVINO C++ API
Apache License 2.0
114 stars 151 forks source link

[Good First Issue]: Add basic git based code checks #663

Open Wovchena opened 2 months ago

Wovchena commented 2 months ago

Context

As a first step to improving GenAI code style, basic checks defined in the project's pre-commit configuration should be run.

What needs to be done?

  1. Run 3 checks from https://github.com/openvinotoolkit/model_api/blob/66384b0b747dee0fb3e37c6466115b7e60da3a10/.github/workflows/test_precommit.yml#L12-L16. Python (e.g., black --check .) and C++ specific checks are out of scope.
  2. Fix detected issues. Some files are expected to fail. For example ™ is an expected non ASCII symbol in root README.md. Exclude such files from testing.
  3. Add a new job within the GitHub Actions workflow to https://github.com/openvinotoolkit/openvino.genai/blob/master/.github/workflows/causal_lm_cpp.yml to run these three checks.
  4. Submit a pull request (PR).

Example Pull Request

https://github.com/openvinotoolkit/openvino.genai/pull/315

Resources

Contact points

@Wovchena

rk119 commented 2 months ago

.take

github-actions[bot] commented 2 months ago

Thank you for looking into this issue! Please let us know if you have any questions or require any help.

tejasathalye commented 3 days ago

.take

github-actions[bot] commented 3 days ago

Thank you for looking into this issue! Please let us know if you have any questions or require any help.