Skip to content

Commit 871f83d

Browse files
committed
run prettier on markdown files
1 parent 91a595b commit 871f83d

File tree

1 file changed

+45
-45
lines changed

1 file changed

+45
-45
lines changed

.github/CONTRIBUTING.md

Lines changed: 45 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ All work related to the application takes place on Github itself. We use [Issues
4141

4242
## Branching Model
4343

44-
The `master` branch of donation-page is relatively stable branch which we use for both development and deployment. We also have auto deployment on this branch itself i.e any changes in that branch gets reflected in [https://donate.coderplex.org](https://donate.coderplex.org).
44+
The `master` branch of donation-page is relatively stable branch which we use for both development and deployment. We also have auto deployment on this branch itself i.e any changes in that branch gets reflected in [https://donate.coderplex.org](https://donate.coderplex.org).
4545

4646
## Development Workflow
4747

@@ -87,53 +87,53 @@ We welcome pull requests from beginners and seasoned JavaScript developers alike
8787

8888
#### Running Locally
8989

90-
1. Fork the [repository](https://github.com/coderplex/donation-page).
91-
1. Then clone your forked repository
92-
```bash
93-
git clone <your forked repository url>
94-
```
95-
1. Move to the repository root folder
96-
```bash
97-
cd donation-page
98-
```
99-
1. [Yarn](https://yarnpkg.com)
100-
101-
* Minimum version v1.2.0+
102-
* Installing instructions are at [official docs](https://yarnpkg.com/en/docs/install#windows-tab). Use yarn over npm
103-
104-
> Our team's official policy (for now) is: We only use [Yarn](https://yarnpkg.com/en/docs/install) as our official Node package manager, and so we request you to use Yarn instead of npm and commit `yarn.lock` file.
105-
106-
1. Install dependencies
107-
```bash
108-
yarn
109-
```
110-
1. Setting up with few things, to get it running.
111-
This project uses some environment variables that hold the values required to make API calls to the API provided by [Razorpay](https://razorpay.com/) and [Airtable](https://airtable.com/). You can ignore this if you're just focussing on the frontend. But, you would need these, if you want to test the API calls made to process the payments or make changes to the API.
112-
113-
Create two files named `.env` and `.env.build` and those files should look something like this.
114-
contents of `.env` file:
90+
1. Fork the [repository](https://github.com/coderplex/donation-page).
91+
1. Then clone your forked repository
92+
```bash
93+
git clone <your forked repository url>
11594
```
116-
RZP_TEST_KEY=YOUR_TEST_KEY(optional)
117-
RZP_TEST_SECRET=YOUR_TEST_SECRET(optional)
118-
RZP_LIVE_KEY=
119-
RZP_LIVE_SECRET=
120-
AIRTABLE_KEY=
121-
AIRTABLE_BASE_ID=
122-
AIRTABLE_TABLE_NAME=
95+
1. Move to the repository root folder
96+
```bash
97+
cd donation-page
12398
```
99+
1. [Yarn](https://yarnpkg.com)
124100

125-
contents of `.env.build` file:
101+
- Minimum version v1.2.0+
102+
- Installing instructions are at [official docs](https://yarnpkg.com/en/docs/install#windows-tab). Use yarn over npm
126103

104+
> Our team's official policy (for now) is: We only use [Yarn](https://yarnpkg.com/en/docs/install) as our official Node package manager, and so we request you to use Yarn instead of npm and commit `yarn.lock` file.
105+
106+
1. Install dependencies
107+
```bash
108+
yarn
127109
```
128-
RZP_TEST_KEY=YOUR_TEST_KEY(optional)
129-
RZP_LIVE_KEY=
110+
1. Setting up with few things, to get it running. This project uses some environment variables that hold the values required to make API calls to the API provided by [Razorpay](https://razorpay.com/) and [Airtable](https://airtable.com/). You can ignore this if you're just focussing on the frontend. But, you would need these, if you want to test the API calls made to process the payments or make changes to the API.
111+
112+
Create two files named `.env` and `.env.build` and those files should look something like this.
113+
contents of `.env` file:
114+
```
115+
RZP_TEST_KEY=YOUR_TEST_KEY(optional)
116+
RZP_TEST_SECRET=YOUR_TEST_SECRET(optional)
117+
RZP_LIVE_KEY=
118+
RZP_LIVE_SECRET=
119+
AIRTABLE_KEY=
120+
AIRTABLE_BASE_ID=
121+
AIRTABLE_TABLE_NAME=
122+
```
123+
124+
contents of `.env.build` file:
125+
126+
```
127+
RZP_TEST_KEY=YOUR_TEST_KEY(optional)
128+
RZP_LIVE_KEY=
129+
```
130+
131+
1. Start the development server
132+
```bash
133+
yarn dev
130134
```
131-
1. Start the development server
132-
```bash
133-
yarn dev
134-
```
135-
Go to `localhost:3000` in the browser of your choice.
136-
> You may get this [error](#local-host-occupied) if any other app is already running the above port.
135+
Go to `localhost:3000` in the browser of your choice.
136+
> You may get this [error](#local-host-occupied) if any other app is already running the above port.
137137

138138
#### Before submitting
139139

@@ -165,18 +165,18 @@ Follow the prompt and commit `.all-contributorsrc` and `README.md` in the PR.
165165
166166
1. Pull latest code from [upstream repository's](https://help.github.com/articles/merging-an-upstream-repository-into-your-fork/)`master`, if in case anything new were merged while you were working on your fork.
167167
1. Push the code to your fork.
168-
1. Raise the pull request from your created branch to `master` branch of coderplex.
168+
1. Raise the pull request from your created branch to `master` branch of coderplex.
169169
1. Take some time to give a brief description of the work you have done.
170170

171171
#### After submitting
172172

173173
1. Wait for all checks to pass in below section.
174174
> You might see a check fail from now-bot saying that there are failures in deployment. Don't worry about it, you don't have access rights to deploy. You can see the status of your check once any reviewer triggers the deployment.
175175
1. The core team will review your pull request and either merge it, request changes to it, or close it with an explanation.
176-
<!-- 1. Your changes are deployed with a unique link `https://deploy-preview-xx--coderplex.netlify.com`.
177176

178-
_`- xx` is your pull request number._ -->
177+
<!-- 1. Your changes are deployed with a unique link `https://deploy-preview-xx--coderplex.netlify.com`.
179178

179+
_`- xx` is your pull request number._ -->
180180

181181
##### Received a review request
182182

0 commit comments

Comments
 (0)