{"id":22218287,"url":"https://github.com/coders-school/simple-text-communicator","last_synced_at":"2026-03-19T22:08:30.241Z","repository":{"id":220024841,"uuid":"745827018","full_name":"coders-school/simple-text-communicator","owner":"coders-school","description":null,"archived":false,"fork":false,"pushed_at":"2024-04-03T21:13:17.000Z","size":123,"stargazers_count":0,"open_issues_count":16,"forks_count":0,"subscribers_count":6,"default_branch":"main","last_synced_at":"2024-04-03T21:50:00.442Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"CMake","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/coders-school.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2024-01-20T09:04:20.000Z","updated_at":"2024-04-14T21:37:21.514Z","dependencies_parsed_at":"2024-03-24T14:31:15.416Z","dependency_job_id":"a95a58ae-4857-494a-b463-f4525cf171d7","html_url":"https://github.com/coders-school/simple-text-communicator","commit_stats":null,"previous_names":["coders-school/simple-text-communicator"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coders-school%2Fsimple-text-communicator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coders-school%2Fsimple-text-communicator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coders-school%2Fsimple-text-communicator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coders-school%2Fsimple-text-communicator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/coders-school","download_url":"https://codeload.github.com/coders-school/simple-text-communicator/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245414550,"owners_count":20611367,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-12-02T22:20:09.953Z","updated_at":"2026-01-06T03:47:20.979Z","avatar_url":"https://github.com/coders-school.png","language":"CMake","funding_links":[],"categories":[],"sub_categories":[],"readme":"# simple-text-communicator\n![Diagram UML](/res/diagram_uml)\n\n### Code Guidelines\n\n1. **Class Naming Conventions:**\n   - Class names should begin with a capital letter, following CamelCase convention. For example: `DatabaseHandler`.\n\n2. **Private Class Members:**\n   - Private class members should be named with an underscore suffix. For instance, `int m_counter`.\n\n3. **Variable Naming:**\n   - Use meaningful and descriptive names for variables.\n   - Follow camelCase convention for variable names.\n   - Avoid single-letter names or abbreviations unless they are widely recognized.\n   - Global variables should be avoided whenever possible. If needed, prefix them with \"g_\" for clarity.\n\n4. **Function Naming:**\n   - Use verbs or verb phrases to describe functions' actions.\n   - Follow camelCase convention for function names and function arguments\n\n5. **Comments:**\n   - Use comments to explain complex algorithms, non-trivial decisions, or any code that might be unclear.\n   - Comments should be clear, concise, and written in English.\n   - Avoid redundant comments that merely restate the code.\n\n6. **Indentation and Formatting:**\n   - Use formatting from .clang-format(in VS code ctrl + shift + i)\n\n7. **Error Handling:**\n   - Always handle errors gracefully. Use exceptions where appropriate.\n   - Use descriptive error messages for better debugging and maintenance.\n\n8. **Memory Management:**\n   - Prefer smart pointers (e.g., `std::unique_ptr`, `std::shared_ptr`) over raw pointers whenever possible.\n   - Use RAII (Resource Acquisition Is Initialization) principle for resource management.\n\n9. **Const-Correctness:**\n   - Utilize `const` keyword appropriately to indicate immutability where applicable.\n   - Prefer `const` references over pass-by-value for function parameters when the parameter won't be modified.\n\n10. **Code Reusability and Modularity:**\n    - Write modular and reusable code.\n    - Break down complex functionalities into smaller, more manageable functions or classes.\n\n11. **Standard Library Usage:**\n    - Utilize features provided by the C++ Standard Library whenever possible rather than reinventing the wheel.\n\n12. **Naming Conventions for Constants:**\n    - Constants should be all uppercase with underscores separating words. For example: `const int MAX_SIZE = 100;`.\n\n13. **File Organization:**\n    - Each class declaration and its implementation should reside in separate header (.h) and source (.cpp) files, respectively.\n    - Group related header files in a separate directory (e.g., `include`).\n\n14. **Version Control:**\n    - Utilize version control systems (e.g., Git) effectively.\n    - Commit regularly with meaningful commit messages.\n    - Please squash your commits before you push it to remote repository\n\n15. **Testing:**\n    - Write comprehensive unit tests to validate the correctness of the code.\n    - Test edge cases and unexpected inputs.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcoders-school%2Fsimple-text-communicator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcoders-school%2Fsimple-text-communicator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcoders-school%2Fsimple-text-communicator/lists"}