Add to quick start documentation: once you create a case, do not change the sandbox

Abierto
#129 3 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

  • #437 de @monsterlag — cerrado sin fusionar

Evaluación

Dificultad
1/5
Tiempo estimado
Menos de una hora
Aptitud para principiantes
45/100
Tipo de issue
Documentación
Claridad
Bien especificado
Estado de actividad
Estancado

Línea de trabajo

Lee la guía de inicio rápido de CESM/CIME y localiza dónde se explica la creación de un case. Añade una advertencia clara de que el código checked-out del directorio de código fuente no debe cambiar hasta que el case esté completo, idealmente en una sección de puntos importantes. La tarea estará terminada cuando la advertencia esté presente en la documentación de inicio rápido y se renderice de forma coherente con el contenido circundante.

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

Descripción

documentation

A seemingly unintuitive aspect of CESM/cime is that, once you have created a case from a particular directory, it is very important not to change the code checked out in that directory until you are completely done with your case. Is that documented somewhere? I don't see it in the quick start guide, and that seems like a good place to include a warning about this. Maybe we can have a section at the end like "Important points to bear in mind"?

Lenguaje dominante
Python
Estrellas
495
Forks
253
Merge medio
34 min
PR fusionados (30 d)
4

Preparar el entorno

  • Sin Dockerfile ni archivo de Docker Compose
  • Tiene una plantilla de pull request
  • Sin 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.

Más de ESCOMP/CESM

Todos los issues de ESCOMP/CESM

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.