Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Changes to CONTRIBUTING.md #1261

Draft
wants to merge 16 commits into
base: next
Choose a base branch
from

Conversation

unjust
Copy link
Member

@unjust unjust commented Nov 18, 2022

Tenemos un wiki con contenido y varios READMEs que podemos linkear/actualizar para describir el proceso de contributing mas clara.

https://github.com/unjust/bootcamp/blob/contributing_wiki_1249/CONTRIBUTING.md
https://github.com/unjust/bootcamp/blob/contributing_wiki_1249/DEPLOYMENT.md

  • Agregamos secciones a CONTRIBUTING con contenido de wiki y como contribuir contenido en particular (topics, projects, OAs)
  • Agregamos pasos que falta a DEPLOYMENT
  • Linkear contributing al README principal
  • Borrar partes a wiki repetidas en el readme, pero quiza quedamos con styleguides alla, y linkeamos esos al README contributing

CONTRIBUTING.md Outdated Show resolved Hide resolved
@unjust unjust self-assigned this Nov 18, 2022
@unjust unjust linked an issue Nov 18, 2022 that may be closed by this pull request
@mfdebian mfdebian linked an issue Nov 22, 2022 that may be closed by this pull request
@unjust unjust added this to the v5.6.0 milestone Nov 22, 2022
@unjust unjust added content Relacionado al contenido de proyectos y tópicos and removed content Relacionado al contenido de proyectos y tópicos labels Nov 22, 2022
Copy link
Member

@lupomontero lupomontero left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Gracias por el PR @unjust

He dejado algunos comentarios con algunas sugerencias 💪

CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
@unjust unjust marked this pull request as draft February 7, 2023 19:38
@unjust unjust modified the milestones: v5.6.0, TBD Feb 7, 2023
@unjust unjust modified the milestones: 6.3, TBD Apr 18, 2023
@unjust unjust modified the milestones: TBD, 6.3 May 11, 2023
@unjust unjust added help wanted Extra attention is needed content Relacionado al contenido de proyectos y tópicos labels May 11, 2023
* Tono coloquial (tú en vez de usted)
* Narración dirigida a la estudiante como lectora, 2da persona, singular (ie: en esta
lección aprenderás a ...)
* **Femenino genérico o `x` para neutro (ie: `Todxs lxs programadorxs`)** TODO: resalta eso o cambiar/omitirlo - el x se dificulta lecturas de pantalla
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Quiero ver si hay mejor segurencia porque todxs y programadorxs no es muy accessible.

Comment on lines +220 to +223
TODO: donde mencionamos el siguiente:

Dependiendo de la naturaleza del contenido, se decidirán los detalles
exactos ya que no todos los proyectos o tópicos tienen la misma naturaleza._
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Aun estoy pensando donde poner eso.


Estructura de archivos de un tópico:

<!-- TODO: revisa con alpi -->
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Quiero verificar que lo de abajo aun esta una estructura valida de un topic.
He observado que los directorios unidades no tienen README.md - son un directorio para partes no mas.

Una manera de familiarizarse con la estructura de este archivo es ver
[este ejemplo de template](https://github.com/Laboratoria/bootcamp/blob/main/topics/_template/README.md).

El `README` debe tener:
Copy link
Member Author

@unjust unjust Jun 26, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Abajo con esta lista necesito tus 👀 . Intente separar requisitos con "partes adicionales" que a veces parecen. Tambien hay algunos secciones que solo aparecen en los unidades (no los topicos en general) por ejemplo Objetivos de aprendiaje. Por favor me avisan si estoy equivocado. Mira que estoy usando para tachar.

Comment on lines +61 to +62
<!-- ~* Objetivos de aprendizaje (`learningObjectives`)~ _required_ solo veo en unidades -->
<!-- * Guía de preguntas y conceptos clave (`keyConcepts`) solo en unidades -->
Copy link
Member Author

@unjust unjust Jun 26, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Estoy tachando Publico objetivo.
Y solo veo esos partes de "OAs" y "Preguntas claves" en unidades de topicos (no en topicos).
Me parece los Objetivos pueden ser requistios porque estan en todo los unidades creo, pero no se si las pruebas exigen.

Comment on lines +63 to +64
~* Evaluación (`grading`)~ _required_
~* Contribuidores (`contributors`)~ _required_
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No los veo esos partes. Quitamos?

Comment on lines +53 to +54
1. Track de tópico `track` (`web-dev`, `ux`, etc)
2. Título(`title`) _required_
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Me parece que Track y Titulo son requisitos. Hay algun otro front-matter mas que track?

Comment on lines +56 to +57
~* Descripción (`description`)~ _required_
~* Tags: (`tags`)~ _required_ <!-- mira functional js -->
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Me parece que descripcion y tags ya no usamos o exigimos, esta bien si omitimos o aun sirve un funcion?

tópico y que contiene el contenido de partes.


<!-- TODO: Me parece que solo los unidades de ejercicios tiene un README con
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Me parece que solo los unidades de ejercicios tiene un README con front matter de duracion. Es asi?

Comment on lines +139 to +141
Recomendamos que cada unidad empiece con una parte _lectura_ de **apertura** o
**opening** y termine con una de **cierre** o **closing**.
Por ejemplo, la unidad 01 arriba tiene `00-apertura`, `06-cierre`.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hay apertura y cierra? solo veo opening and closing como nombres de directrios - son en ingles.
Tambien me pregunto si los nombres de carpetas y archivos, unidades y partes debe tener nombres en ingles o no es importante?

Cada parte es un directorio dentro un unidad, y debe tener
su propio `README.md`.

El `README.md` debe tener:
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tambien abajo quiero ver cuales son required y no.
Como required entiendo que si o si necesitan seguir eso y es probable si no tienen va a causar un error con el parser.

hr *
body (el cuerpo/contenido)

* obligatorio
Copy link
Member Author

@unjust unjust Jun 26, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cuando sepa cuales son obligatorios voy a revisar ese grafica y *

```
Los tipos son `lectura/read`, `práctica/practice`, `cuestionario/quiz`,
`self-paced` (Leer mas de tipos y formatos.)[]
<!-- TODO: ingles o espanol para tipos -->
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

usamos ingles o espanol para los tipos type?

│ │ │ │ └── un-ejercicio.spec.js
│ │ │ └──README.md
│ │  ├── 02-otro-ejercicio
│ │  └── README.md************* // TODO describe que hace aqui?
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Mi pregunta es cuando hay un README dentro un parte que tiene challenges - el readme solo contiene eso

---
type: practice
duration: 30min
---

# Ejercicios

No se si cumple un funcion o ese readme no es necesario.

Ejemplo topics/javascript/09-errors/05-practice/README.md

pero son ellxs quienes dirigen la actividad.


### Challenges
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

este parte es completamente nuevo.
Seria bueno tener 👀

@unjust
Copy link
Member Author

unjust commented Jun 26, 2023

@lupomontero @mfdebian por ahora necesito respuestas/ayuda con mis preguntas en
contributing/TOPICS.md

@unjust
Copy link
Member Author

unjust commented Jun 30, 2023

@unjust unjust changed the base branch from main to next July 10, 2023 19:47
@unjust unjust modified the milestones: Next release, TBD Jul 20, 2023
@unjust unjust modified the milestones: TBD, next release Jul 24, 2023
@unjust unjust modified the milestones: next release, TBD Aug 7, 2023
@unjust unjust removed this from the TBD milestone Nov 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content Relacionado al contenido de proyectos y tópicos help wanted Extra attention is needed
Projects
None yet
3 participants