Skip to content

Latest commit

 

History

History
90 lines (72 loc) · 4.75 KB

README.md

File metadata and controls

90 lines (72 loc) · 4.75 KB
Raw

Fitness-Accountability @ #FitDevs

Discord | Twitter

Quick Introduction

Quick access index

Step 1 - Creating a JSON file
Step 2 - Inputting information in the JSON file
Step 3 - Committing the file
Step 4 - Create a pull request

Step 1 - Creating a JSON file

First, click on the data folder of this repository

image

Then, create a new file by clicking Add file and then Create new file

image

image

Then, name the new file as your Github username followed by .json such as win21H2.json

↑ Go to top ↑

Step 2 - Inputting information in the JSON file

In the file you just made, copy and paste the template:

{
  "name": "",
  "url": "",
  "image": "",
  "why": "",
  "weekly": [],
  "goal": "",
  "location": ""
}

and fill out the information with the help of the below notes

  • Name: You can use your github name, actual name, or a pseudonym!
  • Url: Please insert Github link here, we will expand the user json files to include socials in the future
  • Image: You can use any appropriate profile image here (make sure it is a valid image URL e.g. https://github.com/win21H2.png)
  • Why: Please write down your reason why you have joined the #FitDevs community!
  • Weekly: Your goals for fitness, can be food/exercise/mental/emotional, whatever fitness means to YOU

    Such as the below
["Running 6x", "Abs 6x", "Pushups 6x"]

or

["Drinking 500ml Water 3/day", "Meatless Mondays 2x/month", "Sleeping 7h 6/week"]

Please make sure to use commas in between each goal otherwise it would break the JSON file

  • Goal: What is your overarching goal?
  • Location: Be as vague or as specific as you would like to

A full example below:

image

↑ Go to top ↑

Step 3 - Committing the file

Make sure that before you click the Propose new file button, that you have made the below changes:

  • Fill out the title, this can just be Create [USERNAME].json
  • Fill out a summary, this can just be Added information to my JSON file
  • Create a new branch and name it something like [USERNAME]-my-card and start a pull request by clicking the Propose new file button.

    image

↑ Go to top ↑

Step 4 - Create a pull request

By now, you should be brought to a new page, click the green Create pull request button and if everything works, it should look like the last image. Congrats! you have just created your own "card" which will manually be reviewed by a member of the Github team and will be merged! Once your pull request has beeen merged, you will be able to see it on the main website.

image

image

Find this example in this sample pull request

If there are any issues such as ones related to this guide, please create an issue and we will try to fix it as fast as possible!

Thanks,
The #FitDevs GitHub team

↑ Go to top ↑