-
-
Notifications
You must be signed in to change notification settings - Fork 2.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: 📝 Update README and contribution instructions
- Loading branch information
1 parent
e886d1b
commit b37db3c
Showing
2 changed files
with
38 additions
and
15 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,25 @@ | ||
# Contributing | ||
# Contributing to Typebot | ||
|
||
You are considering contributing to Typebot. I thank you for this 🙏. | ||
|
||
Any contributions you make are **greatly appreciated**. It can be anything from typo fixes to new features. | ||
|
||
Let's [discuss](https://github.com/baptisteArno/typebot.io/discussions/new) about what you want to implement before creating a PR if you are unsure about the requirements or the vision of Typebot. | ||
|
||
## Get started | ||
|
||
1. [Fork](https://help.github.com/articles/fork-a-repo/) this repository to your | ||
own GitHub account and then | ||
[clone](https://help.github.com/articles/cloning-a-repository/) it to your local device. | ||
|
||
2. Create a new branch: | ||
|
||
```sh | ||
git checkout -b MY_BRANCH_NAME | ||
``` | ||
|
||
3. Follow [Local setup instructions](https://github.com/baptisteArno/typebot.io#local-setup) | ||
|
||
Ideally, new features should have e2e tests. Check out existing tests in `/apps/builder/playwright/tests` and `/apps/viewer/playwright/tests`. | ||
|
||
If you struggle writing new tests you can still create a WIP Pull request and I will help you 😃 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
b37db3c
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Successfully deployed to the following URLs:
builder-v2 – ./apps/builder
app.typebot.io
builder-v2-typebot-io.vercel.app
builder-v2-git-main-typebot-io.vercel.app
b37db3c
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Successfully deployed to the following URLs:
viewer-v2 – ./apps/viewer
bot.matthesv.de
gmqtops.com
gevenice.com
chat.matthesv.de
gollum.riku.ai
app.yvon.earth
bot.contakit.com
chat.hayuri.id
granitemj.com
gelville.com
graniteerwin.com
bot.dsignagency.com
92109660.therpm.club
viewer.typebot.io
demo.wemakebots.xyz
zap.fundviser.in
graniteempirecin.com
88584434.therpm.club
thegraniteempire.com
bot.digitalpointer.id
bot.outstandbrand.com
bot.pratikmandalia.com
countertopscolumbia.com
michaeljackson.riku.ai
link.venturasuceder.com
criar.somaperuzzo.com
invite.bridesquadapp.com
chat.thehomebuyersusa.com
granitedepotasheville.com
granitedepotknoxville.com
typebot-viewer.vercel.app
bot.adventureconsulting.hu
chat.atlasoutfittersk9.com
liveconvert.kandalearn.com
granitedepotcrossroads.com
tarian.theiofoundation.org
granitedepotcountertops.com
lavergne.thegraniteempire.com
bot.pinpointinteractive.com
granitequartzgreeneville.com
viewer-v2-typebot-io.vercel.app
viewer-v2-git-main-typebot-io.vercel.app