fork of https://github.com/sourcegraph/zoekt
Add short contributing guide (#907)
Closes #241
author
Julie Tibshirani
committer
GitHub
date
(Jan 31, 2025, 8:54 AM -0800)
commit
fc8c2bf8
fc8c2bf80ff74dbfd4941a638025b53c1075182d
parent
27aef112
27aef1126a4fd97a2347795cceff33b5081b2f9c
+17
+17
CONTRIBUTING.md
+17
CONTRIBUTING.md
···
1
+
# Contributing
2
+
3
+
We welcome contributions to the project! To propose a change, please fork the repository, make your changes, then submit
4
+
a pull request. If the change is significant or potentially controversial, please open an issue first to discuss it.
5
+
Zoekt does not require a CLA to contribute.
6
+
7
+
Before opening a pull request, make sure that you have run the tests locally:
8
+
```sh
9
+
go test ./...
10
+
```
11
+
12
+
It's also good to run a local smoke test for the relevant component. For example, if you've made changes in
13
+
`zoekt-git-index`, you can try indexing a repository locally:
14
+
```sh
15
+
go run ./cmd/zoekt-git-index /path/to/repo
16
+
```
17
+