docs: self code review

This commit is contained in:
Rotimi Best
2023-09-30 06:24:32 +00:00
parent ef604e7660
commit 0f3aa9434a

View File

@@ -56,12 +56,12 @@ To get up and running we have 2 options that you could try out, the first is wit
If you choose to get setup locally, we also have a well documented guide to hold you through the process, you can find it [here](https://formbricks.com/docs/contributing/setup)
### 👩🏽‍💻 **Codebase Overview**
### 👩🏽‍💻 Codebase Overview
Our codebase is a [monorepo](https://en.wikipedia.org/wiki/Monorepo) which means we have different projects in one repository. At moment we have 3 different projects:
1. **demo** `apps/demo` - It's a simple React app that you can run locally and use to trigger actions and set **[Attributes](https://formbricks.com/docs/attributes/why)**. It allows you to test your setup easily.
2. **formbricks-com** `apps/formbricks-com` - The landing page of F[ormbricks](https://formbricks.com)
2. **formbricks-com** `apps/formbricks-com` - The landing page of [Formbricks](https://formbricks.com)
3. **web** `apps/web` - Our [cloud offering](https://app.formbricks.com/) for Formbricks.
<Image src={MonorepoImage} alt="Formbricks monorepo folder structure" className="w-full rounded-lg" />
@@ -74,15 +74,15 @@ We also have a set of packages which we manage: They are located in the `package
<Image src={PackagesFolderImage} alt="Formbricks packages folder" className="w-full rounded-lg" />
### ⚖️ **Contribution Guidelines**
### ⚖️ Contribution Guidelines
You want to get started contributing? Amazing! Checkout our must-read post on [How we Code at Formbricks](https://formbricks.com/docs/contributing/how-we-code). This will give you everything you need to know about successfully contributing to our codebase in no time.
### 🤗 **Our Community**
### 🤗 Our Community
We really value our community. It might be small but it is close to our hearts. Join our [Discord](https://formbricks.com/discord) to learn from other contributors an meet the Formbricks community.
We really value our community. It might be small but it is close to our hearts. Join our [Discord](https://formbricks.com/discord) to learn from other contributors and meet the Formbricks community.
### **Conclusion**
### Conclusion
Contributing to open source projects like Formbricks can be a rewarding experience. By contributing, you have the opportunity to make a meaningful impact on a project used by many and gain valuable experience in the process.