Skip to content

Latest commit

 

History

History
34 lines (23 loc) · 1.92 KB

CONTRIBUTING.md

File metadata and controls

34 lines (23 loc) · 1.92 KB

Contributing to our GenAI Showcase

Thank you for showing interest in contributing to this repo!

General guidelines

Here are some things to keep in mind for contributions:

  • Follow the "fork and pull request" workflow when possible. Internal contributors may use "branch and pull request".
  • Look for duplicate PRs or issues that have already been opened before opening a new one.
  • Ensure your PR passes formatting and linting, as well as any testing checks before requesting a review.
    • If you would like comments or feedback, please open an issue or discussion and tag a maintainer.
  • In the pull request description, link to any issues that the PR aims to resolve, and clearly specify the intent of the PR.
  • Keep scope as isolated as possible.
  • PRs should ideally be merged by PR authors. If for some reason you need to merge someone else's PR, please first check with the author.
  • Merge your PR only after you have received atleast 1 approval from a code owner.

Linting and Formatting

This repo uses pre-commit for managing linting and formatting. pre-commit performs various checks on the files and uses tools that help follow a consistent style within the repo.

To set up pre-commit locally, run:

brew install pre-commit
pre-commit install

To run pre-commit manually, run pre-commit run --all-files.

Questions?

Reach out to the maintainers: Richmond Alake, Apoorva Joshi, Pavel Duchovny, Jesse Hall, Anaiya Raisinghani