Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add short contributing guide #907

Merged
merged 1 commit into from
Jan 31, 2025
+17 −0
Merged

Add short contributing guide #907

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we have a PR template and if no, we should create one so that any person sending a PR fills out a baseline set of information we need

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We do not! Our current issue and PR volume is low, and I haven't seen a need for an issue or PR template yet. We can add one once we start to identify a theme like "I wish people would always include X".

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
```

Loading