search

duafatimaa / timmsi

MIT License
0 stars 0 forks source link

readme

Welcome to Timmsi

Introduction to GitHub

If this is your first time ever using GitHub, then you might want to develop some beginner skills at https://skills.github.com/. Though, we will try to walk you through with the following instructions:

Want Training?

If you like to learn and collaborate together, then join us at https://curiosityhive.org

Contributing & Earning Money

We welcome Pull Requests from everyone, whether you are a student, a teacher, or an expert in the field. When first making a pull request, please keep it short & brief as we establish a relationship.

:money_mouth_face: $\color{green}{Want}$ $\color{green}{to}$ $\color{green}{Make}$ $\color{green}{Money!?}$- We provide compensation for substantial contributions to our projects. Add a USDT Coin Account in your Profile Bio to be compensated.

1. Clear Your Workspace

  1. Open a new tab to be used for research on your favorite Search Engine (Tab 1)
  2. Close All Other Tabs and all other Apps except this Guide (Tab 2)

    Note Make sure you learn the Ctrl-Click command when you click links. Ctrl-Click will be used throughout this guide.

2. Search for Open Issues

Look through the following Organization's Issues below by hitting (Ctrl-Click) on the link, based upon your area of interest.

3. Find an Issue that Matches Your Interest

Continue browsing the Issues Tab (Tab 3) to find an issue suitable for your skills and interests on the newly opened tab. This chart below describes a few of our most common issue types:

4. Project Discovery

If the entire project has been put in motion well, then there will be a master Readme.md file explaining what this project is with proper links on it. Also, if the person who made the issue you chose tried really hard, then they will have supplied a lot of links and instructions right in the issue. That is usually not the case. Usually, you're going to have to try really hard to really understand what the issue is even referring to. This means you will need to do Project Discovery to see if you will have fun and can even comprehend the issue you've chosen. If it doesn't make sense, you can always comment and ask for clarification before you start an issue & ask the manager to communicate better.
To tackle Project Discovery yourself, do the following:

  1. On the Issue Page, Ctrl-Click the <> Code Button in the upper-left area of the Issue you have chosen.
  2. Right-Click the newly created GitHub Code Browser (Tab 4)
  3. Choose "Duplicate Tab" which will make a new GitHub Code Browser (Tab 5)
  4. If Possible, click the master Button and click on gh-pages in the selected options (Sometimes not available)
  5. Search the Readme.md to find out the website link.
  6. Either Ctrl-Click the Website link, or open a new tab and browse to it if it's not clickable. (Tab 6)

5. Prepare Your Workspace

You should now have 6 Tabs total that hold together your entire workspace. Take a pause at this point to make sure you are organized with the following tabs:

  1. Search Engine
  2. This Guide
  3. GitHub Issues Page
  4. GitHub Code Browser
  5. GitHub Code Browser #2
  6. Website of Project

6. Understand the Issue

Next, you will toggle between all the tabs above multiple times so you can get a good understanding of the issue you chose and interact with the issue until the issue is fully known and comprehensive. This process is known as Requirement Engineering (RE). Here are a few common steps great engineers practice for really powerful RE.

  1. Open the Website (Tab 6)
  2. Browse around and make yourself comfortable
  3. Tab Back-and-forth between the website & the issue (Tabs 3 & 6)
  4. Use the Search Engine to research the topic if you need further help. (Tab 1)
  5. If you have questions or need clarification, then write a comment in the issue area (Tab 3)
  6. You may also want to add your links you are researching in the comment section to help others who are working on this same issue. (Tab 3)
  7. Repeat Steps 1-7 until you are extremely confident that you can move forward.

7. Start Making Changes

We will now use a trick to convert Tab 5 to a new workspace.

  1. Go to GitHub Code Browser #2 (Tab 5)
  2. Find the file you want to edit.
  3. Hit the "." dot button on your keyboard.

    Note This will auotmatically convert this tab into a GitHub Web Editor (GWE).

  4. In the GWE, Continue editing the files you want to work on.
  5. Refer back to the issue you chose periodically to see updates and to write comments as you feel necessary as you continue to make changes.

    Warning You MUST continue to Step 8 within 2 hours, otherwise your updates might conflict with others who are working on this same issue!

8. Save Your Changes

  1. Go to the GitHub Issue Page (Tab 3)
    • Keep Note of your Issue #.
  2. Go to the GWE Area (Tab 5)
  3. Click on the Source Control Icon (or Press Ctrl-Shift-G)
  4. Type in a Short Summary in the Message field of What Changes You Made followed by Issue Number

    Example: Updated Titles for Landing Page #82

  5. Press Ctrl-Enter to Submit Changes

    Note If this is your first time saving here, then Click "Fork Repository" to Continue

  6. Press Enter to Create the New Pull Request from the Notification Bar
  7. Press Enter to Confirm Creating a Patch Branch
  8. Choose "Cancel" when asked if want to switch to the Pull Request

    Note If You have actually want to see your changes, then go ahead and choose "Switch to Pull Request"

    Then, to make further changes, you'll need to do the following procedure:

    1. Click on the GitHub Pull Request (PR) Button
    2. Click "Create New Pull Request..."
    3. Change the "Into" Area so it is pointing you to the right branch.
    4. We usually have to change this from "main" to "gh-pages"
    5. Write a Description of what you are changing and why.
    6. Click the "Create" button to finalize your Pull Request (PR)

      The system will remember your selection, so be careful what you choose.
      You will need to return to the main branch in lower-left of screen if you do change

9. Continue Editing

After You have Saved, Repeat Steps 1-7 to continue editing and making contributions.

🔨🔨🔨 Contributing for Advanced Level

  1. Download VS Code Insider's Edition.
  2. Choose the look you want.
  3. Sync to and from other device by signing in with your GitHub account.
  4. Click Extensions Icon on VS Code and install the following:
    • Azure Repos
    • GitHub Pull Requests and Issues
    • GitHub Repositories
    • Live Server
    • Live Share Extension Pack
    • Markdown Preview Enhanced
    • Remote Repositories
  5. From your GitHub tab on your internet browser find the URL to clone.
  6. Open a Terminal on VS Code.
  7. Clone the repository.
  8. Click Allow.
  9. Authorize VS Code. It will redirect to VS Code.
  10. It will give you few options of your Repos, select one repo.
  11. Create a folder in Local Disk C named "Repo".

  12. When doing commits, syncing should only take 5 seconds, so check your browser and authorize it.

    For more information, use this link as a reference.

    Need to Make Changes to a Pull Request?

    Sometimes, you'll work on an issue and you'll be asked to make changes. No problem! Follow the below guide to easily make changes to your edits.

    1. Prepare Your Workspace

    Go ahead and open all 6 Tabs like you did previously. Take a pause at this point to make sure you are organized with the following tabs:

  13. Search Engine
  14. This Guide
  15. GitHub Issues Page
  16. GitHub Code Browser
  17. GitHub Code Browser #2

  18. Website of Project

    2. Issue Requirement Engineering

    Go to the GitHub Issue Page (Tab 3) and do a deeper study of Requirement Engineering (RE) by doing the following:

  19. Read the comment left by the Issue Manager.
  20. Go to any links provided in the comments and study them thoroughly.
  21. Refer back to Step 6 in the original instructions to Understand the Issue
    • Have a humble approach, knowing that you missed something.
    • Sometimes Requirements change, so the original issue may have been updated, or the manager may have changed their mind.
    • Also, your changes might've inspired something deeper within the issue manager and now they want to further refine this issue for a better end result

  22. Make comments and open a discussion on the issue if you feel you need further clarification before continuing.

    3. Edit the Pull Request (PR)

  23. Ctrl-Click the Commit # on the GitHub Issue Page (Tab 3)

    Note This will be a 7 charachter link that will look something like eb81533

  24. Open this new Commit Tab (Tab 4)
  25. Hit the "." dot button on your keyboard.

    Note This will auotmatically convert this tab into a GitHub Web Editor (GWE). You will now have Side-by-Side Editors. Red on the left is the original. Green on the right is the Updates you made.

  26. In the GWE, Continue editing the files you need to update on the right editor.

  27. Refer back to the issue you chose periodically to see updates and to write comments as you feel necessary as you continue to make changes.

    Warning You MUST continue to Step 8 within 2 hours, otherwise your updates might conflict with others who are working on this same issue!

    4. Save Your Changes

  28. Go to the GitHub Issue Page (Tab 3)
    • Keep Note of your Issue #.
  29. Go to the GWE Area (Tab 5)
  30. Click on the Source Control Icon (or Press Ctrl-Shift-G)
  31. Type in a Short Summary in the Message field of What Changes You Made followed by Issue Number

    Example: Updated Titles for Landing Page #82

  32. Press Ctrl-Enter to Submit Changes

    5. Continue the Discussion

  33. Go to the GitHub Issue Page (Tab 3)
  34. Make a comment, letting the team know you updated your Pull Request
  35. If any changes are needed, then Repeat Steps 1-4 until your PR is Merged.
  36. Once Merged, you can move onto another issue.