DenverCoder1 / DenverCoder1/readme-typing-svg

Add your profile or repository to the README

Open Beginner friendly
#21 15 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation good first issue hacktoberfest invalid pinned
Dominant language
PHP
Stars
9.3k
Forks
1.6k
Avg merge
3d 5h
Merged PRs (30d)
1

Description

Thanks to @WarenGonzaga for the idea of putting example usages in the README.

There is now an 🚀 Example usage section in the README for profiles and repositories that have unique usages of Typing SVGs.

If you have a particularly cool way of using Typing SVGs on your profile, show it off by leaving a link to your profile in the README.

This issue is beginner friendly, if you have any questions, don't hesitate to ask.

Steps to open a PR

Using GitHub website
  1. Click the pencil above the README to fork the repo and start editing
    image
  2. Add a line at the bottom of the list with your name and a link to your profile in the same format as the other examples
  3. Add a message and create a new branch describing your changes
    image
  4. Click "Propose Changes"
  5. Replace the PR description with "Added example to README" and then click "Create pull request"
  6. You're done! Wait for your pull request to be reviewed.
Using GitHub CLI
  1. Fork the repo by clicking the button in the top-right or by running
gh repo fork DenverCoder1/readme-typing-svg
  1. Clone your fork to your computer (if you did not do so by running gh repo fork)
git clone https://github.com/<YOUR USERNAME>/readme-typing-svg.git
cd readme-typing-svg
  1. Create a new branch and switch to it
git checkout -b added-<YOUR USERNAME>-to-readme
  1. Open README.md in a code editor and add a line at the bottom of the list with your name and a link to your profile in the same format as the other examples
  2. Stage, commit, and push your changes
git add .
git commit -m "Added <YOUR USERNAME> to readme"
git push origin main
  1. View your fork on GitHub and you should see an option to compare and pull request.
  2. Compare your branch with DenverCoder1:main and start creating a Pull Request
  3. Replace the PR description with "Added example to README" and then click "Create pull request"
  4. You're done! Wait for your pull request to be reviewed.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Open README.md and inspect the existing Example usage list. Add your profile or repository as a line matching the surrounding format, then verify the link and formatting before opening a pull request. Done means your entry appears in the README and the pull request is submitted for review.

Written by the indexing model from the issue text.

Assessment

Tech stack
github
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Quiet
Clarity
Clearly specified
Newbie friendliness
78/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.