https://github.com/zyx-0314/github-git-guide

https://github.com/zyx-0314/github-git-guide

Last synced: 2 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/zyx-0314/github-git-guide
• Owner: zyx-0314
• Created: 2024-04-18T15:08:14.000Z (9 months ago)
• Default Branch: main
• Last Pushed: 2024-09-06T02:03:43.000Z (5 months ago)
• Last Synced: 2024-11-24T05:08:20.847Z (2 months ago)
• Size: 128 KB
• Stars: 10
• Watchers: 1
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

        










  

    

  


  
Github - Git & Readme Guides






![](https://visit-counter.vercel.app/counter.png?page=zyx-0314/Github-Git-Guide)

---







  Table of Contents

  


    


      Project Overview

    

    


      Git Guides

    

    


      Readme Collection

      


        


          Readme Project Sample

        

        


          Readme Design and Tools Collection

        

      

    

    


      Contributors

    

    


      How to Contribute

      


        


          Fork Repository

        

        


          Report an Issue

        

        


          Give a Star

        

      

    

  


---

## Project Overview

This project serves as a comprehensive reference guide for utilizing GitHub and creating effective README documentation. It includes a collection of solutions and workarounds for common issues encountered on GitHub, making it a valuable resource for beginners.

Contributors to the project have identified and addressed a variety of challenges, offering guidance and support to newcomers navigating GitHub and README best practices. The project also features examples of potential README designs, statistical insights, and useful GitHub commands.

We encourage you to participate by making requests, reporting issues, sharing your expertise, and collaborating with us to enhance this resource. Let’s work together to create a supportive community for GitHub users of all levels.




(back to top)


---

## Git Guides

The Git Guides section is organized into a collection of markdown files within the project's directory at **[./git/settingup-git-windows.md](https://github.com/zyx-0314/Github-Git-Guide/blob/main/git/settingup-git-windows.md)** for windows and **[./git/settingup-git-mac.md](https://github.com/zyx-0314/Github-Git-Guide/blob/main/git/settingup-git-mac.md)** for mac. This comprehensive guide covers a variety of essential Git information and workflows, including:

- Installation of Git with VS Code Windows & Mac*

  - Useful extensions for Pull Request, Issues, Cloning and Publishing

- External Git Guides:

  - [Deploying Simple Website](https://scribehow.com/shared/Deploy_a_website_using_GitHub_Pages__UyFSCsflSte7l0IhcvFFdg?referrer=workspace)

  - [Using Template Repository for Projects](https://scribehow.com/shared/Create_Repository_Based_on_Template_on_GitHub__uqrFu1o3T3iETD9bBMGFlQ?referrer=workspace)

- Problems in [Github and VS Code](https://github.com/zyx-0314/Github-Git-Guide/blob/main/git/problems.md)

- Best Practices in Git Commit Messages [Commits](https://github.com/zyx-0314/Github-Git-Guide/blob/main/git/commit.md)

*(Still in works)




(back to top)


---

## Readme Collection

The Readme Collection is a repository curated by FEU IT students. It serves as a compendium of instructions, components, and discovered APIs suitable for integration into readme files.

---

### Readme Project Sample

The following are the list of Accounts where Readme can be found;

|User|Type|Link|

|

Legends:

- Minimalist

- Anime

- Futuristic




---

### Readme Design and Tools Collection

The following are the list of Readme Designs.

Each Technology has insturuction and sample on how to use.

| Design Name | Link | Remark | Instructions |

|-|-|-|-|

| Waka Time | [WakaTime](https://wakatime.com/) | used to keep track of activity time in projects, ide, os and langugae | wakatime.md |

| Daily Dev Card | [daily.dev](https://daily.dev/) | creation of dev card profile | [Scribe Instructions](https://scribehow.com/shared/Create_Dailydev_Devcard_in_Horizontal_Layout_with_Code_copied__DGmdmjIuQGGu7H0J1ofThg?referrer=workspace) |

| 3D Github Contributions | [OpenTTD/isometric](https://github.com/OpenTTD/OpenTTD) | for more dramatic 3d representation of github contribution chart | [Just Install This](https://chromewebstore.google.com/detail/github-isometric-contribu/mjoedlfflcchnleknnceiplgaeoegien) |

| Technology Badges | [Readme Badges](https://github.com/alexandresanlim/Badges4-README.md-Profile) | use badges to design your read with the technologies you know or your using. Instead of just text why not add some badges | soon... |




(back to top)


---

## Contributors




(back to top)


---

## How To Contribute

You can contribute by Forking and Doing a Pull Request, reporting an issue/s or giving us star.

### Forking

You can make your own copy of the project by Forking the project.



You can contribute by doing Pull Request after you modify the project. 







### Report an Issue

If you encounter any issues or bugs, please create an issue on the GitHub repository.

Steps:

1. Find the Issue Tab



2. Find the New Issue Button



4. Add a Short Title



6. Add Descriptions



Format of Description

   i.   Problem - Describe the problem

   ii.  Step-by-Step of how the problem occur, if possible with screen-shots

   iii. if there is variables, include at the bottom

---

Format sample:

The problem is something like this and it does this but should do this, im using mac laptop and i use this kind of ide.

Step-by-Step:

Step 1: Open the terminal

Step 2: Choose option 2

Step 3: Enter Values

Step 4: Problem Occur here that should be something like this but it does this.

Variables:

the values I placed are;

1 - for registration

2 - Dela Cruz for Last name

---

7. Submit









### Giving a Star

If you find this project interesting, consider giving it a star on GitHub. You can also follow the repository for updates and notifications.






(back to top)