Skip to content

Conversation

@skullxcode
Copy link
Contributor

πŸ“‹ Pull Request Description

What does this PR do?

Type of Change

  • πŸ“ New documentation
  • ✏️ Documentation improvement (typo, clarity, examples)
  • πŸ› Bug fix (non-breaking change fixing an issue)
  • ✨ New feature (CLI enhancement, new functionality)
  • 🎨 Refactoring (code improvement without changing functionality)
  • πŸ“š New topic/section
  • ❓ Interview questions added/improved
  • πŸ“„ Cheatsheet added/improved

Related Issue

Closes #(issue number)

Changes Made

  • Added new topic
  • Change 2
  • Change 3

Documentation Location (if applicable)

  • Files changed: docs/folder/file.md
  • New files: docs/c-sharp/c-sharp-basics.md

βœ… Checklist

General

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code/content
  • I have commented my code/documentation where necessary
  • My changes generate no new warnings or errors

Documentation (if applicable)

  • All code examples are tested and working
  • Code examples include comments explaining key concepts
  • Examples show expected output where relevant
  • Markdown formatting is correct
  • File naming follows conventions (lowercase with hyphens)
  • Content is beginner-friendly yet comprehensive
  • Links to related topics are included

Code Changes (if applicable)

  • My code follows JavaScript best practices
  • I have tested the CLI tool locally
  • No breaking changes to existing functionality

Commit Messages

  • My commit messages are clear and descriptive
  • I used conventional commit format (Add:, Fix:, Update:, etc.)

πŸ“Έ Screenshots (if applicable)

πŸ§ͺ Testing

How to Test

# Example commands to test
npm link
devdocx javascript/arrays

Test Results

  • Tested locally
  • All examples work as expected
  • CLI commands work properly

πŸ“š Additional Context

πŸŽƒ Hacktoberfest


Note to Reviewers:

πŸ“ Before Merging

  • Documentation is clear and accurate
  • Code examples work correctly
  • No typos or grammatical errors
  • Follows project structure and conventions

@GreenHacker420 GreenHacker420 added documentation Improvements or additions to documentation good first issue Good for newcomers hacktoberfest hacktoberfest-accepted labels Oct 15, 2025
@GreenHacker420 GreenHacker420 merged commit 25b1ace into GreenHacker420:main Oct 15, 2025
2 of 3 checks passed
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR adds comprehensive documentation for C# and C++ tech stacks, introducing beginner-friendly reference guides for both languages that cover essential tools, frameworks, and best practices for modern development.

Key Changes:

  • Added C# tech stack documentation covering .NET SDK, ASP.NET Core, and related tooling
  • Added C++ tech stack documentation covering compilers, CMake, and modern C++ practices
  • Included practical code examples, CI/CD configurations, and best practices for both languages

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.

File Description
docs/c-sharp/c-sharp-basics.md New documentation file providing a comprehensive overview of the C#/.NET tech stack with examples and best practices
docs/c++/cpp-basics.md New documentation file providing a comprehensive overview of the C++ tech stack with examples and best practices

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@@ -0,0 +1,126 @@
// ...existing code...
Copy link

Copilot AI Oct 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove the placeholder comment '// ...existing code...' on line 1. This is a comment artifact that doesn't belong in a new file and adds no value to the documentation.

Suggested change
// ...existing code...

Copilot uses AI. Check for mistakes.
using Xunit;

public class Calculator {
public int Add(int a,int b) => a + b;
Copy link

Copilot AI Oct 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add a space after the comma in the parameter list. The method signature should be 'Add(int a, int b)' to follow C# formatting conventions and improve readability.

Suggested change
public int Add(int a,int b) => a + b;
public int Add(int a, int b) => a + b;

Copilot uses AI. Check for mistakes.
int add(int a, int b) { return a + b; }

TEST_CASE("addition works") {
REQUIRE(add(2,3) == 5);
Copy link

Copilot AI Oct 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add a space after the comma in the function call. It should be 'add(2, 3)' to follow C++ formatting conventions and improve readability.

Suggested change
REQUIRE(add(2,3) == 5);
REQUIRE(add(2, 3) == 5);

Copilot uses AI. Check for mistakes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation good first issue Good for newcomers hacktoberfest hacktoberfest-accepted

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants