Skip to content

dotjesper/hello-world

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Welcome to the Hello World project.

This repository is not just another GitHub repository - it is also a personal learning platform for GitHub best practices, repository management, and solution design. The goal is for this repository to serve as a template for future projects.

If you have comments, ideas, or suggestions, please use Discussions section.

About

This repository contains the source code for the Hello World demonstration project.

Overview

Every IT professional and veteran software developer knows the term Hello World as the first step in learning to code. The program, which outputs some variant of "Hello, World!" on a device's display, can be created in most languages, making it some of the most basic syntax involved in the coding process.

Brian Kernighan, author of one of the most widely read programming books, "C Programming Language", also created "Hello, World". He first referenced Hello World in the C Programming Language book’s predecessor: A Tutorial Introduction to the Programming Language B published in 1973.

Since the first Hello World! program was written in 1972, it has become a tradition to introduce the topic of programming with this example. As a result, Hello World! is often the first program most people write and this repository is no different, this is my sample-ground and learning-area for working with GitHub.

Idea

The Hello World project is built on the principle that the best way to learn is by doing. Rather than treating Hello World as just a simple code example, this repository uses it as a foundation to explore and master GitHub repository management, Git workflows, and development tooling. By building a complete project around this simple concept, we can learn:

  • Repository structure and organization best practices
  • Documentation standards and community engagement
  • Version control workflows including branching strategies
  • Issue tracking, pull requests, and collaborative development
  • Project automation and maintenance practices

This approach transforms a trivial program into a meaningful learning experience that demonstrates professional repository management and GitHub workflows.

Goal

The primary goals of this project are to:

  1. Learn by Example - Create a well-structured, documented reference repository that demonstrates GitHub best practices
  2. Build a Template - Develop reusable patterns and structures for future projects
  3. Practice Workflows - Gain hands-on experience with branching, merging, releases, and collaboration
  4. Document the Journey - Maintain clear documentation that helps others understand both the what and the why
  5. Foster Community - Create a welcoming space for discussion, feedback, and shared learning

Synopsis

Using the "Hello World" concept as inspiration, this project focuses on the infrastructure and practices that surround a repository rather than the code itself - from comprehensive documentation and contribution guidelines to structured layouts and community engagement. The project is designed to grow and evolve as new concepts are explored and mastered.

Content

The repository is organized into the following structure:

 📂 hello-world/
  └─ 📂 .assets/
      └─ 📄 github-repo-card-hello-world.png # Repository card image
     📂 .github/
      ├─ 📂 instructions/
      │   └─ 📄 powershell.instructions.md   # PowerShell coding standards
      ├─ 📂 ISSUE_TEMPLATE/
      │   ├─ 📄 bug_report.yml               # Bug report issue form
      │   ├─ 📄 feature_request.yml          # Feature request issue form
      │   └─ 📄 config.yml                   # Template chooser configuration
      ├─ 📄 copilot-instructions.md          # GitHub Copilot configuration
      └─ 📄 PULL_REQUEST_TEMPLATE.md         # Pull request template
     📂 .vscode/
      ├─ 📄 extensions.json                  # Recommended Visual Studio Code extensions
      ├─ 📄 settings.json                    # Workspace settings
      └─ 📄 tasks.json                       # Task definitions
     📂 solution/
      ├─ 📂 assets/
      │   ├─ 📂 archives/                    # Compressed asset files
      │   └─ 📂 images/                      # Image assets
      ├─ 📂 scripts/
      │   ├─ 📄 Get-RepositoryFile.ps1       # Download files from a GitHub repository
      │   ├─ 📄 Get-RepositoryOverview.ps1   # Repository structure overview
      │   ├─ 📄 Invoke-HelloWorld.ps1        # Hello World demonstration script
      │   ├─ 📄 Invoke-Speedtest.ps1         # Network speed test script
      │   └─ 📄 Set-ShortcutPin.ps1          # Pin shortcuts to Start Menu or taskbar
      └─ 📄 solution.wsb                     # Windows Sandbox configuration
     📄 .editorconfig                        # Cross-editor configuration
     📄 .gitattributes                       # Git attributes configuration
     📄 .gitignore                           # Files to exclude from Git
     📄 CONTRIBUTING.md                      # Contribution guidelines
     📄 LICENSE                              # CC BY-NC-SA 4.0 license
     📄 README.md                            # Repository documentation (this file)

Companion wiki

The project wiki is a companion to this repository - a living notebook capturing deeper notes, decisions, and lessons learned along the way. It covers the full journey from first install to daily use:

Page Description
Part 1 Getting Started Introduction to GitHub, Git and Visual Studio Code
Part 2 Creating a Repository Creating and configuring a GitHub repository
Part 3 Repository Essentials Markdown, README files, and common repository files
Part 4 Branching and Workflows Cloning, branching, pull requests, and the daily Git workflow
Part 5 Working With Repositories Downloading, referencing, and working with repositories programmatically
Part 6 AI as a Learning Companion AI-assisted coding, GitHub Copilot, and Vibe Coding as a learning companion
Part 7 Copilot Configuration Creating, maintaining, and sharing GitHub Copilot custom instructions
Part 8 Field Notes Practical lessons learned and insights collected through hands-on experience
Part 9 Exercises Companion exercises for each part of the wiki

Usage

This repository is primarily a learning and reference resource. To make the most of it:

  1. Explore the Structure - Review how the repository is organized and documented
  2. Read the Documentation - Study the README, CONTRIBUTING, and other documentation files
  3. Check the Wiki - Explore the companion wiki for in-depth guides on every topic covered in this project
  4. Join Discussions - Participate in GitHub Discussions to share ideas
  5. Use as a Template - Fork or reference this structure for your own projects

Contributing and Feedback

Contributions, ideas, and feedback are welcome! Please see the Contributing Guide for details on how to get involved.

  • Issues - Report bugs or request features via GitHub Issues.
  • Discussions - Ask questions, share ideas, or start a conversation via GitHub Discussions.
  • Pull Requests - Fork the repository and submit a pull request with your improvements.

Legal and Licensing

License

This project is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License. You are free to share and adapt the material for non-commercial purposes, as long as you give appropriate credit and distribute any contributions under the same license. See the LICENSE file for details.

Disclaimer

This repository is provided "AS IS" without warranty of any kind, express or implied. The content is subject to change without notice and should not be interpreted as an offer or commitment. This is a personal learning project and demonstration platform, not affiliated with or endorsed by any organization unless explicitly stated. Any mention of third-party products, services, or trademarks is for reference purposes only and does not imply endorsement or affiliation. All trademarks and product names are the property of their respective owners.

Usage Guidelines

Scripts, solutions, or code in this repository may contain additional legal disclaimers or usage notes in their headers or inline comments. Users should review all documentation before use, test thoroughly in non-production environments, and understand that they assume all risks and responsibilities associated with using any content from this repository. It is the user's responsibility to ensure compliance with applicable laws and regulations.

Change log

See the Change Log wiki page for full version history.


Page revised: March 12, 2026

Jesper on Bluesky Jesper on X dotjesper.com

About

This repository contains the source code for the Hello World demonstration project.

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Contributors