From 1942f3347f41293f585d136115470df48685db74 Mon Sep 17 00:00:00 2001 From: Morgante Pell Date: Thu, 30 Nov 2023 13:15:09 -0500 Subject: [PATCH] chore: add grit pattern enforcement (#243) --- .grit/.gitignore | 2 ++ .grit/grit.yaml | 6 ++---- docs/contributing.md | 2 ++ 3 files changed, 6 insertions(+), 4 deletions(-) create mode 100644 .grit/.gitignore diff --git a/.grit/.gitignore b/.grit/.gitignore new file mode 100644 index 0000000..799e2c7 --- /dev/null +++ b/.grit/.gitignore @@ -0,0 +1,2 @@ +.gritmodules +*.log diff --git a/.grit/grit.yaml b/.grit/grit.yaml index e765edb..99bedc5 100644 --- a/.grit/grit.yaml +++ b/.grit/grit.yaml @@ -1,8 +1,6 @@ version: 0.0.1 patterns: - - name: github.com/getgrit/js#* - - name: github.com/getgrit/python#* - - name: github.com/getgrit/json#* - - name: github.com/getgrit/hcl#* - name: github.com/getgrit/python#openai level: info + - name: github.com/getgrit/python#no_skipped_tests + level: error diff --git a/docs/contributing.md b/docs/contributing.md index 51c0201..152b797 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -22,6 +22,8 @@ If it is not a small change, please start by [filing an issue](https://github.co If you need ideas, you can check out the [help wanted](https://github.com/jxnl/instructor/labels/help%20wanted) or [good first issue](https://github.com/jxnl/instructor/labels/good%20first%20issue) labels. +[Grit](https://docs.grit.io/) is used to enforce best practices. You can run `grit check` to check your code before submitting a pull request. + # Contributors