TrevorBrowning/dev-dashboard

Your First Task: Add Your Name to the Project!

Offen

#17 geöffnet am 16.06.2025

 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)JavaScript (6 Forks)auto 404
documentationgood first issue

Repository-Metriken

Stars
 (1 Stern)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

Hey everyone! Welcome to your first official task. The goal here is simple: to practice the full GitHub workflow in a low-pressure way. We're just going to add your name to the project's main page.

Don't worry if this is new to you, just follow these steps one by one.

Step 1: Get the Latest Code

Before you start, let's make sure your computer has the most up-to-date version of the project.

In your terminal, switch to the main branch git checkout main

Now, pull down any recent changes git pull origin main

Step 2: Create Your Own Branch

Next, create your own personal branch to work on. This is like your own private copy where you can't break anything. A good name is chore/add-your-name.

This command creates your new branch and switches to it git checkout -b chore/add-your-name

Step 3: Edit the README File

Open the README.md file in VS Code (Or the code editor you use). Find the "Project Team" section and add your name and a link to your GitHub profile under the correct team list (UI/UX or App Logic), below the current name listed.

Please follow this format:

  • Your Name/Username - YourGitHubUsername example: Trevor Browning - [TrevorBrowning](https://www.github.com/TrevorBrowning)

Step 4: Save Your Work

Now we'll save your change to the project's history using two commands.

First, stage the file you changed git add README.md

Next, commit it with a clear message (remember to change the name!) git commit -m "docs: Add [Your Name] to team list"

Step 5: Push Your Branch to GitHub

This sends your new branch up to the main GitHub repository.

Use this full command since it's a new branch git push --set-upstream origin chore/add-your-name

Step 6: Open a Pull Request

The final step! Go back to our project's page on GitHub.

You should see a yellow bar with your branch name and a green "Compare & pull request" button. Click it.
Give your PR a simple title, like "Add [Your Name] to README".
In the description box, just write Closes #17 to link it to this issue.
Click "Create pull request".

That's it! You've just completed a full professional workflow. I'll review and merge your PRs as they come in. If you get stuck on any step, please ask for help in our project chat or shoot me a message!

Contributor Guide