Skip to content

Commit

Permalink
Merge pull request #15 from pranavaurora/master
Browse files Browse the repository at this point in the history
changing contributing guide
  • Loading branch information
kesmit13 authored Oct 5, 2023
2 parents 6544a4c + e30aa03 commit 00950b2
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# SingleStore Spaces Contributing Guide

First, please fork this repo and commit your changes to forked repo. From there make a Pull Request with your notebook submission keeping the following in mind:


## File structure

To add a new space you should create a new folder inside `/notebooks`.
Expand All @@ -26,3 +29,18 @@ title="Atlas & Kai for Mongo Side-by-Side"
description="Compare performance on same code from simple to more complex queries"
tags=["mongodb", "kai"]
```


## Pre-commit checks on the clone of this repo

The CI pipeline in this repo runs a bunch of validation checks and code reformatting with pre-commit checks. If you don't install those checks in your clone of the repo, the code will likely never pass. To install the pre-commit tool in your clone run the following from your clone directory. This will force the checks before you can push.

```bash
pip3 install pre-commit
pre-commit install
```

The checks run automatically when you attempt to commit, but you can run them manually as well with the following:
```bash
pre-commit run --all-files
```

0 comments on commit 00950b2

Please sign in to comment.