Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

Please consider refining (reorganizing/documenting) core headers to aid in their explicit inclusion ...

Cerrado
  • ¿Algo no está bien?
#121 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
5/5
Tiempo estimado
Más de una semana
Aptitud para principiantes
25/100
Tipo de issue
Nueva funcionalidad
Claridad
Necesita aclaración
Estado de actividad
Estancado
Stack tecnológico
cpp
Área
api, embedded-iot

Línea de trabajo

El issue no identifica archivos ni pruebas específicos. Empieza revisando los encabezados principales de ArduinoCore-API y el comportamiento predeterminado del Arduino IDE con respecto a los proyectos y la inclusión de encabezados; después, aclara el alcance con los maintainers. El trabajo estaría terminado cuando exista un enfoque acordado para encabezados base explícitos, preservar los proyectos existentes, la inspección de encabezados por parte del IDE y el descubrimiento de dependencias.

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

Descripción

(I don't know if this is the correct place to begin this discussion, but if wrong please move it.)

Specifically I believe the current Arduino development environment is hurting beginners by hiding the inclusion of critical header files, which actually define the API's which programming relies upon, and who's inspection should be encouraged to aid beginners more easily understand why ideally well documented functions must be called with certain argument orders and types for example. Please consider reorganizing and refining Arduino's core library/environment header / implementation specification to allow it to more easily serve as a coherent reference to aid in its use; as also further supported by the following proposed changes:

  • change default new project stationary to include "#include <arduino.h>", which need not be equivalent to "Arduino.h", although will likely include it among other base library headers, defining the base Arduinio API.

  • initially continuing to support their magical inclusion behind the scenes, and thereby not breaking anything for existing projects, but beginning the transition to a requirement for its explicit top-level inclusion.

  • add a feature to the IDE to make it easy to open and view included baseline headers, and those from optionally supported libraries (but possibly kept read-only by default, so beginners don't mistakenly modify them).

  • in turn the source code can then be parsed to determine the code's corresponding library dependency required for compilation and linking, etc.

All visible to the user, as hiding such critical information typically hurts more than helps even, if not especially, beginners understand what's going on and why, in practice.

Lenguaje dominante
C++
Estrellas
307
Forks
152
Sin PR fusionados en 30 d

Preparar el entorno

Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.

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.

Más de arduino/ArduinoCore-API

Todos los issues de arduino/ArduinoCore-API

Issues similares

Más issues de C++

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.