Skip to content

Commit 730ef5f

Browse files
authored
[Open Source] Add contributing.md (#853)
This is adapted from our `convex-backend` [contributing.md](https://github.com/get-convex/convex-backend/blob/main/CONTRIBUTING.md)
1 parent 98e20ef commit 730ef5f

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

CONTRIBUTING.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Contributing
2+
3+
Please share any general questions, feature requests, or product feedback in our
4+
[Convex Discord Community](https://convex.dev/community). We're particularly
5+
excited to see what you build using Chef!
6+
7+
Please ensure that JavaScript code is formatted with
8+
[eslint](https://github.com/eslint/eslint) and markdown files are
9+
formatted with [prettier](https://prettier.io/).
10+
11+
Chef is a fast moving project developed by a dedicated team. We're excited to
12+
contribute to the community by releasing this code, but we want to manage
13+
expectations as well.
14+
15+
- We value a cohesive product experience for folks building applications using Chef.
16+
- We value transparency in how we operate.
17+
18+
Smaller PRs that affect documentation, comments, or small bugfixes are easy to
19+
review and integrate. For any larger or more fundamental changes, get in touch
20+
with us on Discord before you put in too much work to see if it's consistent
21+
with our product plans. We are generally unlikely to take large or fundamental
22+
changes as community contributions. We think carefully about how new features
23+
contribute to a cohesive product in line with our roadmap, so we cannot promise
24+
that larger PRs will get the same level of attention.
25+
26+
Instructions for running Chef locally:
27+
28+
- [Running the web app locally](DEVELOPMENT.md)

0 commit comments

Comments
 (0)