Vector AI Engineering template repositoryΒΆ

This template repository can be used to bootstrap AI Engineering project repositories on Github! The template is meant for python codebases since Python is the most commonly used language by our team.

The template includes:

  • pyproject.toml file to specify repository information and manage dependencies using Poetry.

  • README.md which should have basic information on why the project is useful, installation instructions and other information on how users can get started.

  • .pre-commit-config.yaml for running pre-commit hooks that check for code-style, apply formatting, check for type hints and run tests.

  • .github/pull_request_template.md for PRs.

  • .github/ISSUE_TEMPLATE for bug reports and issues that can be raised on the repository.

  • .github/workflows for running CI workflows using Github actions. The template includes CI workflows for code checks, documentation building and releasing python packages to PyPI.

  • LICENSE.md for adding a license to the project repository. By default, this is the Apache-2.0 license. Please change according to your project!

  • docs for adding project documentation. Typically projects should have API reference documentation, user guides and tutorials.

  • CONTRIBUTING.md with basic guidelines on how others can contribute to the repository.

  • CODE_OF_CONDUCT.md with standards on how the community engages in a healthy and constructive manner.

  • .gitignore with some standard file extensions to be ignored by git. Please add/modify as necessary.

  • codecov.yml for using codecov.io to generate code coverage information for your repository. You would need to add codecov.io app as an integration to your repository.

If you are starting a new project, you can navigate to the Use this template button on the top right corner of the template repository home page which will allow you to bootstrap your project repo using this template.

Please check out the user guide page for more detailed information on using the template features. For existing projects, the user guide can be followed to migrate to following the template more closely.