From 9d2c8cad54d643fd9dc1e7231099c681c539177f Mon Sep 17 00:00:00 2001 From: Priyansh Prajapat Date: Fri, 21 Jun 2024 09:37:10 +0530 Subject: [PATCH] docs: new json docs --- CONTRIBUTING.md | 33 ++++++++++++--------------------- 1 file changed, 12 insertions(+), 21 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 831d3e9..58ee15e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,32 +6,23 @@ A fork is a local copy of the repository that is on your GitHub account, and you [**Click here to fork the repository.**](https://github.com/oyepriyansh/DevProfiles/fork) ### 2. Add profile code snippet -add following code to HTML `index.html` inside the `
` `
` - -```html -
-
User Image
-

Your Name

-
- [SKILL-1] - [SKILL-2] - [SKILL-3] -
- -
+add following JSON code to `data.json` file + +```json + { + "name": "YOUR_NAME", + "image": "IMAGE_url", + "github": "YOUR GITHUB URL", + "twitter": "YOUR X/TWITTER URL", + "linkedin": "YOUR LINKEDIN URL", + "skills": ["SKILL-1", "SKILL-2", "SKILL-3"] + } ``` -> [!IMPORTANT] -> Don't add your profile at the beginning or end of the file. Put it anywhere in between, this is to avoid conflicts whiile having rush in Pull Requests - ### 3. Fill Placeholder Change/Replace the placeholders with your image and profiles urls - - [IMAGE-URL] with your image URL - [YOUR_NAME] with your name + - [IMAGE-URL] with your image URL - [SKILL-1], [SKILL-2], [SKILL-3] with your skills - [YOUR GITHUB URL], [YOUR X/TWITTER URL] & [YOUR LINKEDIN URL] with your Github, X/Twitter & LinkedIn profile URL repectively.