awatertrevi/infisical
1
0
Fork 0
mirror of https://github.com/awatertrevi/infisical.git synced 2026-09-22 13:39:35 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update contributing docs, add pull requests section

Browse Source
This commit is contained in:
Tuan Dang
2023-05-31 12:25:08 +03:00
parent 720ab446f9
commit 94141fedd6
4 changed files with 58 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
docs/contributing/developing.mdx
View File

@@ -1,16 +1,16 @@
---
title: 'Local development'
description: 'This guide will help you set up and run Infisical in development mode.'
description: 'This guide will help you set up and run Infisical in local development.'
---
## Clone the repo
## Fork and clone the repo
```bash
# navigate location to the path you want Infisical to be installed
[Fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) the [repository](https://github.com/Infisical/infisical) to your own GitHub account and then [clone](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) it to your local device.
# clone the repo and cd to Infisical dir
git clone https://github.com/Infisical/infisical
cd infisical
Once, you've done that, create a new branch:
```console
git checkout -b MY_BRANCH_NAME
```
## Set up environment variables
@@ -62,8 +62,8 @@ View all available [environment variables](https://infisical.com/docs/self-hosti
## Starting Infisical for development
We use use Docker to easily spin up all required services to have Infisical up and running for development. If you are unfamiliar with Docker, don't worry, all you have to do is install [Docker](https://docs.docker.com/get-docker/) for your
machine and run the commands below to start up the development server.
We use Docker to spin up all required services for Infisical in local development. If you are unfamiliar with Docker, don’t worry, all you have to do is install Docker for your
machine and run the command below to start up the development server.
#### Start local server