diff --git a/apps/docs/app/developer-docs/contributing/page.mdx b/apps/docs/app/developer-docs/contributing/page.mdx index bd526ad2a1..6215efe82b 100644 --- a/apps/docs/app/developer-docs/contributing/page.mdx +++ b/apps/docs/app/developer-docs/contributing/page.mdx @@ -29,8 +29,8 @@ We are so happy that you are interested in contributing to Formbricks 🤗 There - **Issues**: Spotted a bug? Has deployment gone wrong? Do you have user feedback? [Raise an issue](https://github.com/formbricks/formbricks/issues/new/choose) for the fastest response. - **Feature requests**: Raise an issue for these and tag it as an Enhancement. We love every idea. Please give us as much context on the why as possible. - **Creating a PR**: Please fork the repository, make your changes and create a new pull request if you want to make an update. - - **E2E Tests**: Understand how we write E2E tests and make sure to write whenever you ship a feature [here](https://www.notion.so/Formbricks-End-to-End-Tests-06dc830d71604deaa8da24714540f7ab?pvs=21). - - **Introducing a new Question Type?**: Adding a new question type to our surveys? Follow this guide to make sure you’re on the right track [here](https://www.notion.so/Guidelines-for-Implementing-a-New-Question-Type-9ac0d1c362714addb24b9abeb326d1c1?pvs=21). + - **E2E Tests**: Understand how we write E2E tests and make sure to write whenever you ship a feature [here](https://formbricks.notion.site/Formbricks-End-to-End-Tests-06dc830d71604deaa8da24714540f7ab?pvs=4). + - **Introducing a new Question Type?**: Adding a new question type to our surveys? Follow this guide to make sure you’re on the right track [here](https://formbricks.notion.site/Guidelines-for-Implementing-a-New-Question-Type-9ac0d1c362714addb24b9abeb326d1c1?pvs=4). - **How we Code at Formbricks**: View this Notion document and understand the coding practises we follow so that you can adhere to them for uniformity. - **How to create a service**: Services are our Database abstraction layer where we connect Prisma (our DB ORM) with logical methods that are reusable across the server. View this document to understand when & how to write them. - **Roadmap**: Our roadmap is open on GitHub tickets and some customer and community tickets on GitHub. @@ -124,8 +124,9 @@ After clicking the one-click setup button, Gitpod will open a new tab or window. quality="100" className="max-w-full rounded-lg sm:max-w-3xl" /> -- This is the Gitpod Authentication Page. It appears when you click the "Open in GitPod" button and Gitpod needs -to authenticate your access to the workspace. Click on 'Continue With Github' to authorize your GitPod session. +- This is the Gitpod Authentication Page. It appears when you click the "Open in GitPod" button and Gitpod +needs to authenticate your access to the workspace. Click on 'Continue With Github' to authorize your GitPod +session. ### 3. Creating a New Workspace @@ -135,11 +136,12 @@ to authenticate your access to the workspace. Click on 'Continue With Github' to quality="100" className="max-w-full rounded-lg sm:max-w-3xl" /> -- After authentication, Gitpod asks to create a new workspace for you. This page displays the configurations of -your workspace. - You can use either choose either VS Code Browser or VS Code Desktop editor with the 'Standard -Class' for your workspace class. - If you opt for the VS Code Desktop, follow the following steps 1. Gitpod will -prompt you to grant access to the VSCode app. Once approved, install the GitPod extension from the VSCode Marketplace -and follow the prompts to authorize the integration. 2. Change the `WEBAPP_URL` and the `NEXTAUTH_URL` to `https://localhost:3000` +- After authentication, Gitpod asks to create a new workspace for you. This page displays the configurations +of your workspace. - You can use either choose either VS Code Browser or VS Code Desktop editor with the +'Standard Class' for your workspace class. - If you opt for the VS Code Desktop, follow the following steps 1. +Gitpod will prompt you to grant access to the VSCode app. Once approved, install the GitPod extension from the +VSCode Marketplace and follow the prompts to authorize the integration. 2. Change the `WEBAPP_URL` and the +`NEXTAUTH_URL` to `https://localhost:3000` ### 4. Gitpod preparing the created Workspace @@ -160,8 +162,8 @@ page while Gitpod sets up your development environment. quality="100" className="max-w-full rounded-lg sm:max-w-3xl" /> -- Once the workspace is fully prepared, voila, it enters the running state. You can start working on your project -in this environment. +- Once the workspace is fully prepared, voila, it enters the running state. You can start working on your +project in this environment. ### Ports and Services