hsf-training / hsf-training/cpluspluscourse

Good practices to discuss in the course

Open
#507 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

stale
Dominant language
TeX
Stars
313
Forks
104
PR merge metrics
No merged PRs in 30d

Description

A compilation of suggestions from #78

  • Interfaces -I.3 (singletons) as well as I.11 & I.13 (avoid raw_ptr ownership transfer, avoid passing arrays without length)
  • Errors - E.6 use RAII
  • Classes - C.131 Avoid trivial getters/setters
  • If you have a debate about how to do something, check core guidelines
  • When to use free functions (anonymous namespace) and when member functions
  • Keep headers clean, low number of includes? (#508)
  • Discuss SOLID principle at the end of OOP

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing issue #78 and the referenced header-cleanliness issue #508, then inspect the course materials to locate the relevant OOP and guideline sections. The issue provides discussion topics but no target files or tests; completion would require deciding which suggestions belong in the course and incorporating the agreed material.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
content, documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.