mapbox / mapbox/cpp

Running list of more terms/concepts we could document in glossary

Abierto
#36 5 comentarios 1 reacción 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

glossary
Lenguaje dominante
Sin datos de lenguaje
Estrellas
110
Forks
17
Métricas de merge de PR
Sin PR fusionados en 30 d

Descripción

The glossary is developing quickly into a pretty solid resource for the key terms you'll encounter and need to know while learning C++ at Mapbox. Or when starting to teach colleagues about how we write, deploy, and approach C++ at Mapbox.

While the glossary says explicitly that It is not intended to be a complete reference on language or syntax terms, there is much more we can do. This is a ticket to brainstorm additional concepts, terms, and keywords that are potential things to cover in the glossary and related docs.

Most of these terms don't need to be defined in the glossary, rather it would be sufficient to simply list them and links to external resources (particularly style guides we support). The overall goal is 1) note they are important to understand for C++ development a mapbox (by their presence), and 2) provide a great resource to learn more about them. We can add extra definitions where our opinions matter.

(Will be editing this in place as I collect ideas)

Key learning concepts
  • the idea of a main function in an executable
  • how to pass arguments to a C++ program and parse them - refs #35
  • const
  • const char* vs std::string and how they relate
  • pointers vs references
  • dereferencing pointers
  • taking the address of a variable
  • header guards vs #pragma once
  • learning the cpp preprocessor
  • what are templates and when to use them
  • global variables, why not to use them, when they are appropriate
  • when to use static_cast, reinterpret_cast, and const_cast. Why to use them rather than c style cases
  • how enumerations work enum in C++11. Using casts to change between them and integer types
  • the max size of numeric types. using <limits> from the stdlib to know these sizes dynamically
  • integer overflow. When it is undefined behavior, when it is defined. How to control it/prevent it. How it differs for signed types and unsigned types
  • compiler warnings. how to avoid them, fix them, appropriately suppress them. Why, when starting projects, it makes sense to use -Werror and very aggressive warnings, even -Weverything
  • how to use c++ exceptions: why to always make custom exceptions subclass std::exception. How to catch all types by catching std::exception. Why to catch exceptions by const&.
  • when to avoid throwing exceptions due to performance concerns (e.g. in tight loops)
  • what is garbage collection
  • What is reference counting
  • Why, when, and how to use std::unique_ptr vs std::shared_ptr
  • zero copy
  • Big takeaways of C++11 vs C++14 vs c++17
  • move semantics / universal references
  • considerations on when to use std::vector vs std::map vs std::list
  • binary size, why it matters, how you can learn about it (https://github.com/google/bloaty)
  • What is the _GLIBCXX_USE_CXX11_ABI flag on linux and why does it matter?
Advanced performance concepts

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Línea de trabajo

Comienza con glossary.md y revisa la lista existente de conceptos de C++ y recursos externos propuestos. El issue es más un registro abierto de lluvia de ideas que una tarea de documentación definida; para completarlo habría que acotar el alcance y acordar qué términos o enlaces añadir.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
cpp
Área
documentation
Tipo de issue
Documentación
Dificultad
5/5
Tiempo estimado
Más de una semana
Estado de actividad
Estancado
Claridad
Necesita aclaración
Aptitud para principiantes
25/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.