Update contributing docs, add pull requests section

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

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, dont 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

View File

@@ -3,9 +3,12 @@ title: "Overview"
description: "We welcome any contributions to Infisical, big or small."
---
To set a strong foundation, this section outlines how we, the community and members of Infisical,
should approach the development and contribution process.
## Community
It's the early days of Infisical and we're working hard to build an awesome, inclusive community. In order to grow this, all community members must adhere to our Code of conduct.
We are building an inclusive community, and this means adhering to the [Code of Conduct](/contributing/code-of-conduct).
## Bugs and issues
@@ -26,7 +29,9 @@ If you're ever in doubt about whether or not a proposed feature aligns with Infi
## Writing and submitting code
Anyone can contribute code to Infisical. To get started, check out the local development guide, make your changes, and submit a pull request to the main repository.
Anyone can contribute code to Infisical. To get started, check out the [local development guide](/contributing/developing), make your changes, and submit a pull request to the main repository
adhering to the [pull request guide](/).
## Licensing

View File

@@ -0,0 +1,40 @@
---
title: 'Pull requests'
description: 'This guide walks through the code submission process for Infisical.'
---
## Making a pull request
Once you are done making changes in local development, you can submit a pull request (PR) to the main repository branch.
We require a few considerations on your part to ensure that PRs are easy to review and up to standard with the code.
### Title and content
Start by providing a concise title addressing what your PR achieves such as "add pagination to retrieve environment variables for GitLab integration."
You should follow the automatically-generated PR template to fill in the PR description. This includes a more detailed description of the changes in the PR, the type of PR, and an acknowledgement that you've read and agreed to the contributing guidelines.
### Feature PRs
Give a functional overview of how your feature works, including how the user can use the feature. Then share any technical details in an overview of how the PR works.
As of `06-01-2023`, all PRs created after this date are required to attach a video of you performing the described functionality.
### Bug Fix PRs
Give an overview of the bug at hand and how your PR fixes the it at both a high and low level.
Feel free to add a short video or screenshots of what your PR achieves.
## Getting your PR reviewed
Once your PR is reviewed, one or two relevent members of the Infisical team should review and approve the PR before it is merged. You should coordinate and ping the team member closest to the submitted functionality via our [Slack](https://infisical.com/slack) to review your PR.
- Vlad: Frontend, Web UI
- Tony: Backend, SDKs, Security
- Maidul: Backend, CI/CD, CLI, Kubernetes Operator
The team member(s) will start by enabling baseline checks to ensure that there are no leaked secrets, new dependencies are clear, and the frontend/backend services start up. Afterward, they will review your PR thoroughly by testing the code and leave any feedback or work in with you to revise the PR up to standard.
Once everything is good, the team member(s) will approve the PR to be merged into the `main` branch; all changes will be tested in CI/CD and our staging environment first before being deployed to production.

View File

@@ -328,7 +328,8 @@
"pages": [
"contributing/overview",
"contributing/code-of-conduct",
"contributing/developing"
"contributing/developing",
"contributing/pull-requests"
]
}
],