CONTRIBUTING.md

Contributing to RDS Status-Site

• How to Start
• Yarn Command Reference
• API Contracts
• Setting Up Local System
• Prerequisite
• Raising a Pull Request

1. How to Start

Read this guide to learn how to clone,fork and raise a PR.

2. Yarn Command Reference

Set-up

yarn install

Development

To run the project yarn run dev.

To run the project with Mocked APIs

• Configure your development browser to trust https://localhost with invalid certificate, follow this doc
• Make sure the variable NEXT_PUBLIC_API_MOCKING is ON in .env.development file

Production

To do a production build yarn run start.

3. API Contracts

API contracts can be found here.

4. Setting Up Local System

1. Get Authenticated cookie
   Click this link to redirect to authenticating page.
2. To get the CORS error resolved follow this doc

5. Prerequisite

1. Next.js
2. TypeScript
3. React TypeScript cheatsheet

6. Raising a Pull Request

1. Write tests
2. Double check the code before every commit/push
3. Have on-point commit messages
4. Write useful descriptions and titles
5. Add comments on your pull request to help guide the reviewer
6. Make it visual. Add Images or GIFs if needed.
7. Link the PR to the issue you are working on
8. Convert the PR to Draft if the work is still in progress
9. Make sure the checkbox "Allow edits by maintainers" is checked