Skip to content

TIDBITS-SUBMISSION-GUIDE.md

Latest commit

 

History

History
46 lines (34 loc) · 2.45 KB

TIDBITS-SUBMISSION-GUIDE.md

File metadata and controls

46 lines (34 loc) · 2.45 KB
Raw

Hello there! 👋

Please read and understand this guide well to submit a TidBit on the tapaScript.io website.

Create an Issue

First things first, please create an issue by going to this link: https://github.com/tapascript/tapascript.io/issues

  • Click on the New Issue button and select Tidbit as the option image
  • Then provide a Title(Do not remove the existing text in the title text field). Provide answers to all the questions asked and create the issue image

Fork the Repo

Fork the https://github.com/tapascript/tapascript.io repository. If you are new to forking, please take the help of this step-by-step video to learn and proceed: https://www.youtube.com/watch?v=h8suY-Osn8Q

Create the Content

  • After forking the repo, clone it locally and browse to the /tidbits/content directory.
  • You will find a file called a-sample-tidbit.mdx inside the directory.
  • Create a copy of the file with a name(with the .mdx file extension) that is suitable for your content. Remember, this name will eventually become the slug(URL fragment) of your tidbit. So give it wisely 😄.
  • Now start putting your content:
    • ENTER THE TIDBIT TITLE
    • ENTER A DESCRIPTION
    • ENTER A DATE IN YYYY-MM--DD FORMAT
    • ENTER A FEW(MAX 5) TAGS
    • ENTER THE LINK TO THE COVER IMAGE
    • ENTER YOUR GITHUB USER NAME
    • BELOW THE DIVIDER(---) START ADDING YOUR CONTENT IN MARKDOWN FORMAT.
  • Now commit your changes
  • Push to your forked repository
  • Create a Pull Request to the upstream, mentioning the issue number in the description.
  • (Optionally), if you are on the tapaScript discord, you can post your PR link in the #website channel.

After you create the PR

After you have created and submitted the PR, we will review it, and there could be any of these possibilities:

  • All good, we merged the PR.
  • We provide you with review comments to work on. Once you have taken care of them, we merge the PR
  • We do not merge the PR if we do not align on things.

What happens after we merge the PR?