starred/C
1
0
Fork 0
mirror of https://github.com/TheAlgorithms/C.git synced 2026-04-23 05:49:37 +00:00
Code Issues 1.4k Packages Projects Releases Wiki Activity

[PR #543] [MERGED] Major rework to improve code quality, add automation checks and self hosted autogenerated documetnation website #966

New Issue
Open
opened 2026-01-29 15:16:31 +00:00 by claunia · 0 comments
claunia commented 2026-01-29 15:16:31 +00:00
Owner
Copy Link

📋 Pull Request Information

Original PR: https://github.com/TheAlgorithms/C/pull/543
Author: @kvedala
Created: 6/8/2020
Status: ✅ Merged
Merged: 6/28/2020
Merged by: @kvedala

Base: master ← Head: master

📝 Commits (10+)

  • 42f56b6 use signed int for openmp for loop
  • 38e0a23 warning free print uint64
  • d004f03 added link to online google colab notebook
  • e4ac34d print message if OpenMP was found or not
  • b8e650d Merge branch 'master' of github.com:kvedala/C
  • 447b116 read number from commandline & use long long unsigned integers
  • f046534 dynamically large factorial computation
  • 3b4e286 updating DIRECTORY.md
  • d501451 skip C99 required files - complex.h for MSVC
  • a376316 fix openmp for MSVC

📊 Changes

374 files changed (+15598 additions, -9296 deletions)

View changed files

➕ .github/ISSUE_TEMPLATE/bug_report.md (+33 -0)
➕ .github/ISSUE_TEMPLATE/feature_request.md (+20 -0)
➕ .github/pull_request_template.md (+23 -0)
➕ .github/workflows/awesome_workflow.yml (+125 -0)
➕ .github/workflows/gh-pages.yml (+36 -0)
➖ .github/workflows/update_directory_md.yml (+0 -68)
📝 .gitignore (+1 -0)
➕ .gitpod.dockerfile (+9 -0)
➕ .gitpod.yml (+17 -0)
➖ .travis.yml (+0 -5)
➕ .vscode/settings.json (+7 -0)
➖ 872.c (+0 -43)
➕ CMakeLists.txt (+73 -0)
📝 DIRECTORY.md (+141 -98)
➕ Doxyfile (+277 -0)
📝 README.md (+15 -126)
➖ client_server/UDP_Client.c (+0 -49)
➖ client_server/UDP_Server.c (+0 -55)
📝 client_server/client.c (+67 -62)
📝 client_server/server.c (+96 -90)

...and 80 more files

📄 Description

Description of Change

  • Add cmake based structure
  • Include documentation building
  • Add GitHub Actions using cmake to check code compilation on linux (ubuntu), Mac OS and Windows (using MS Visual C/C++ compiler)
  • Add GitHub action to auto-generate documentation and push to repo's respective GitHub Pages -> this will create the website https://thealgorithms.github.io/C similar to https://kvedala.github.io/C
  • add documentations to various source codes including mathematical formulations where possible
  • fix code formatting issues with existing files
  • fix source codes so they compile on all operating systems
  • github actions workflow improved by
    • adding auto format code and file name
    • stage-by-stage actions for efficient checks

This documentation approach will also enable other contributors to add documentation in their respective languages or use google translate to do so.

Checklist

  • Added description of change
  • Added file name normalization - all small letters and no spaces
  • Added tests and example, test must pass - wherever possible
  • Relevant documentation/comments is changed or added
  • PR title follows semantic commit guidelines
  • Search previous suggestions before making a new one, as yours may be a duplicate.
  • Sort by alphabetical order
  • I acknowledge that all my contributions will be made under the project's license.

Note

Before merging, the parent repository branch structure would need to be improved (Adding images branch, adding gh-pages branch). Unless existing maintainers are up for the challenge, I,d like to volunteer to maintain the structure of the repo and the documentation of the same. It’d allow us to have graphs and files for a much better documentation.

🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/TheAlgorithms/C/pull/543 **Author:** [@kvedala](https://github.com/kvedala) **Created:** 6/8/2020 **Status:** ✅ Merged **Merged:** 6/28/2020 **Merged by:** [@kvedala](https://github.com/kvedala) **Base:** `master` ← **Head:** `master` --- ### 📝 Commits (10+) - [`42f56b6`](https://github.com/TheAlgorithms/C/commit/42f56b62ac7a27b03ab34f13c6c800fc02c2ccec) use signed int for openmp for loop - [`38e0a23`](https://github.com/TheAlgorithms/C/commit/38e0a2354c738936ff54a339f20302789b2c4504) warning free print uint64 - [`d004f03`](https://github.com/TheAlgorithms/C/commit/d004f03438c0525fd0319e8d0bd99c5b0280d0ba) added link to online google colab notebook - [`e4ac34d`](https://github.com/TheAlgorithms/C/commit/e4ac34d7966b97c249a9d90f230d19aafc0c71fb) print message if OpenMP was found or not - [`b8e650d`](https://github.com/TheAlgorithms/C/commit/b8e650d0338148d4d6802ea5730774acd3cbff78) Merge branch 'master' of github.com:kvedala/C - [`447b116`](https://github.com/TheAlgorithms/C/commit/447b1160a44cff6ae45cbfde1b3b703f26baba0d) read number from commandline & use long long unsigned integers - [`f046534`](https://github.com/TheAlgorithms/C/commit/f0465347ae282a6d7f86c54bdc0e31daa984ceac) dynamically large factorial computation - [`3b4e286`](https://github.com/TheAlgorithms/C/commit/3b4e2868ceb07b117d8a44565fe9604b409572aa) updating DIRECTORY.md - [`d501451`](https://github.com/TheAlgorithms/C/commit/d5014515cc0ee56368ae6ea6a698cc8ac580831a) skip C99 required files - complex.h for MSVC - [`a376316`](https://github.com/TheAlgorithms/C/commit/a376316d828b34c5ad0a1fb7f8173edb5a048f3c) fix openmp for MSVC ### 📊 Changes **374 files changed** (+15598 additions, -9296 deletions) <details> <summary>View changed files</summary> ➕ `.github/ISSUE_TEMPLATE/bug_report.md` (+33 -0) ➕ `.github/ISSUE_TEMPLATE/feature_request.md` (+20 -0) ➕ `.github/pull_request_template.md` (+23 -0) ➕ `.github/workflows/awesome_workflow.yml` (+125 -0) ➕ `.github/workflows/gh-pages.yml` (+36 -0) ➖ `.github/workflows/update_directory_md.yml` (+0 -68) 📝 `.gitignore` (+1 -0) ➕ `.gitpod.dockerfile` (+9 -0) ➕ `.gitpod.yml` (+17 -0) ➖ `.travis.yml` (+0 -5) ➕ `.vscode/settings.json` (+7 -0) ➖ `872.c` (+0 -43) ➕ `CMakeLists.txt` (+73 -0) 📝 `DIRECTORY.md` (+141 -98) ➕ `Doxyfile` (+277 -0) 📝 `README.md` (+15 -126) ➖ `client_server/UDP_Client.c` (+0 -49) ➖ `client_server/UDP_Server.c` (+0 -55) 📝 `client_server/client.c` (+67 -62) 📝 `client_server/server.c` (+96 -90) _...and 80 more files_ </details> ### 📄 Description #### Description of Change * Add `cmake` based structure * Include documentation building * Add GitHub Actions using `cmake` to check code compilation on linux (ubuntu), Mac OS and Windows (using MS Visual C/C++ compiler) * Add GitHub action to auto-generate documentation and push to repo's respective GitHub Pages -> this will create the website https://thealgorithms.github.io/C similar to https://kvedala.github.io/C * add documentations to various source codes including mathematical formulations where possible * fix code formatting issues with existing files * fix source codes so they compile on all operating systems * github actions workflow improved by * adding auto format code and file name * stage-by-stage actions for efficient checks This documentation approach will also enable other contributors to add documentation in their respective languages or use google translate to do so. #### Checklist <!-- Remove items that do not apply. For completed items, change [ ] to [x]. --> - [x] Added description of change - [x] Added file name normalization - all small letters and no spaces - [x] Added tests and example, test must pass - wherever possible - [x] Relevant documentation/comments is changed or added - [x] PR title follows semantic [commit guidelines](https://github.com/TheAlgorithms/C-Plus-Plus/blob/master/CONTRIBUTION.md#Commit-Guidelines) - [x] Search previous suggestions before making a new one, as yours may be a duplicate. - [x] Sort by alphabetical order - [x] I acknowledge that all my contributions will be made under the project's license. #### Note Before merging, the parent repository branch structure would need to be improved (Adding images branch, adding gh-pages branch). Unless existing maintainers are up for the challenge, I,d like to volunteer to maintain the structure of the repo and the documentation of the same. It’d allow us to have graphs and files for a much better documentation. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
claunia added the pull-request label 2026-01-29 15:16:31 +00:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
bug
dont-close
enhancement
good first issue
hacktoberfest
hacktoberfest
help wanted
invalid
not-an-algorithm
out of date
Practice coding
pull-request
Mirrored from GitHub Pull Request
 question
Stale
wontfix
No Label pull-request
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
claunia
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/C#966
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?