Skip to content

Commit

Permalink
[Chore] Move Git Hook documentation to Contributing.md (#626)
Browse files Browse the repository at this point in the history
fix
  • Loading branch information
Sh0g0-1758 authored Aug 12, 2024
1 parent 925a8f5 commit 5bd1213
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 20 deletions.
21 changes: 21 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,3 +36,24 @@ Please do not:
## Branch Naming

Please name your branch using the `kebab-case` pattern and use common sense to name it, so that its purpose remains clear. For example, if introduces a new feature that adds the allocation hint: `feature-alloc-hint`.

## Setting Up Git Hooks

To ensure code quality and consistency, this project uses a custom pre-commit hook. Follow these steps to set up the pre-commit hook:

Run the setup script to install the pre-commit hook:

```bash
chmod +x ./setup-hooks.sh
./setup-hooks.sh
```

This script will copy the pre-commit hook from the githooks directory to your local .git/hooks directory.

Verify that the pre-commit hook is installed and executable by running:

```bash
ls -l .git/hooks/pre-commit
```

You should see that the pre-commit file is listed and has executable permissions.
20 changes: 0 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,26 +26,6 @@ Currently, it is only possible to use it by building it from source by following

After completing these steps, you can find the compiled VM in `bin/cairo-vm`.

## Setting Up Git Hooks
To ensure code quality and consistency, this project uses a custom pre-commit hook. Follow these steps to set up the pre-commit hook:

Run the setup script to install the pre-commit hook:

```bash
chmod +x ./setup-hooks.sh
./setup-hooks.sh
```

This script will copy the pre-commit hook from the githooks directory to your local .git/hooks directory.

Verify that the pre-commit hook is installed and executable by running:

```bash
ls -l .git/hooks/pre-commit
```

You should see that the pre-commit file is listed and has executable permissions.

### Run The VM

To run the VM you need to have a compiled Cairo file using the Cairo Zero compiler at [cairo-lang](https://github.com/starkware-libs/cairo-lang).
Expand Down

0 comments on commit 5bd1213

Please sign in to comment.