Trench is an open source project and we welcome contributions from the community.
We welcome contributions to improve the backend. Before starting, we recommend opening an issue for discussion to ensure your idea aligns with the project’s goals.
apps/trench
directory and copy the .env.example
file to .env
:Make sure you have the following prerequisites installed:
Start the local development environment:
http://localhost:4000
.pnpm test:e2e
(you will need to be running the dev server locally on port 4000 with HTTP for this to work)Good documentation is crucial and requires significant time and effort to create and maintain. All our documentation is written in Markdown to make it easy for contributors.
apps/docs
directory..mdx
files. Optionally, install and start Mintlify to build the documentation site locally.You can open an issue to report bugs or suggest new features.
Clearly describe the bug, including steps to reproduce it, what happened, and what you expected to happen. Also, include the browser version, OS, and other relevant software versions (npm, Node.js, etc.) when applicable.
Describe the proposed feature, its functionality, why it is useful, and how users should use it. Provide as much information as possible to facilitate discussion, assessment, and implementation. If you are unsure about any aspect of the feature, feel free to leave it open for discussion.
Pull requests are highly appreciated. If you plan to propose significant changes, please open an issue for discussion first to ensure your PR will be accepted before you invest time in coding it.
Trench is an open source project and we welcome contributions from the community.
We welcome contributions to improve the backend. Before starting, we recommend opening an issue for discussion to ensure your idea aligns with the project’s goals.
apps/trench
directory and copy the .env.example
file to .env
:Make sure you have the following prerequisites installed:
Start the local development environment:
http://localhost:4000
.pnpm test:e2e
(you will need to be running the dev server locally on port 4000 with HTTP for this to work)Good documentation is crucial and requires significant time and effort to create and maintain. All our documentation is written in Markdown to make it easy for contributors.
apps/docs
directory..mdx
files. Optionally, install and start Mintlify to build the documentation site locally.You can open an issue to report bugs or suggest new features.
Clearly describe the bug, including steps to reproduce it, what happened, and what you expected to happen. Also, include the browser version, OS, and other relevant software versions (npm, Node.js, etc.) when applicable.
Describe the proposed feature, its functionality, why it is useful, and how users should use it. Provide as much information as possible to facilitate discussion, assessment, and implementation. If you are unsure about any aspect of the feature, feel free to leave it open for discussion.
Pull requests are highly appreciated. If you plan to propose significant changes, please open an issue for discussion first to ensure your PR will be accepted before you invest time in coding it.