AcademySoftwareFoundation / AcademySoftwareFoundation/OpenColorIO

Don't mix external downloads with checked-in project source

Abierto
#1,386 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Build Issue Needs Discussion
Lenguaje dominante
C++
Estrellas
2.1k
Forks
505
Métricas de merge de PR
Sin PR fusionados en 30 d

Descripción

When certain dependencies aren't found, OCIO's build scripts will download and build them automatically. (Yay!)

But then these files are left around intermixed with source, in the ext/ directory (which also contains sampleicc that is part of the OCIO repo). This is really inconvenient for several reasons: After a build, you have some things in ext that are part of the OCIO source repo, but other things that are NOT. You can't easily get rid of the temporarily downloads with rm -rf ext, and also you have to be super careful with git commit -a lest you accidentally sweep up those external projects along with whatever you are intentionally changing in OCIO's code.

I would suggest considering some subset of the following grab-bag of ideas to help address this:

  • Have one subdirectory for external projects that are purposely embedded in the OCIO repo (like sampleicc), and a separate area for things you download but do not wish to become part of the OCIO project. Make sure you can easily rm -r the temp downloads just as easily and harmlessly as you can blow away the "build" and "dist" areas.

  • Change the build scripts to put the downloads and source of the auto-build external packages in the "build" area, so it's not intermixed anywhere near the source.

  • Add to .gitignore all the things that might be temporary downloads, so that a git commit -a can't possibly sweep them up, and even a git status isn't all cluttered with things that aren't part of the project.

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 inspeccionando los scripts de compilación que descargan dependencias y la disposición actual de ext/; después, revisa .gitignore. Define una separación clara entre los proyectos incluidos en el repositorio, como sampleicc, y las descargas temporales, con una ubicación que se pueda eliminar de forma segura. Se considera terminado cuando las fuentes externas generadas ya no se mezclan con el código fuente del proyecto ni ensucian git status.

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

Evaluación

Stack tecnológico
git
Área
build-system
Tipo de issue
Nueva funcionalidad
Dificultad
4/5
Tiempo estimado
3-5 días
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
35/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.