From ad0488acbe04fd7285a8ae377488214231f17b1d Mon Sep 17 00:00:00 2001
From: thomas <julietibs@apache.org>
Date: Fri, 31 Jan 2025 08:46:51 -0800
Subject: [PATCH] Add short contributing guide

---
 CONTRIBUTING.md | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)
 create mode 100644 CONTRIBUTING.md

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 00000000..a1cab4a9
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -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
+```
+