Skip to content

Commit

Permalink
Add short contributing guide (#907)
Browse files Browse the repository at this point in the history
Closes #241
  • Loading branch information
jtibshirani authored Jan 31, 2025
1 parent 27aef11 commit fc8c2bf
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Contributing

We welcome contributions to the project! To propose a change, please fork the repository, make your changes, then submit
a pull request. If the change is significant or potentially controversial, please open an issue first to discuss it.
Zoekt does not require a CLA to contribute.

Before opening a pull request, make sure that you have run the tests locally:
```sh
go test ./...
```

It's also good to run a local smoke test for the relevant component. For example, if you've made changes in
`zoekt-git-index`, you can try indexing a repository locally:
```sh
go run ./cmd/zoekt-git-index /path/to/repo
```

0 comments on commit fc8c2bf

Please sign in to comment.