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

Contributing Guidelines? #1

Open
dianjuar opened this issue Apr 14, 2017 · 10 comments
Open

Contributing Guidelines? #1

dianjuar opened this issue Apr 14, 2017 · 10 comments

Comments

@dianjuar
Copy link
Member

dianjuar commented Apr 14, 2017

Hola @Villanuevand Interesante propuesta.

Tienes en mente como debe estar estructurado el repo?

  • Sólo enlaces?
  • Lanzar el pdf completo?

sería chévere que en el readme estuviese una guía de todo esto para saber como contribuir.


Por ejemplo, yo tomé un curso de Udemy que me pareció BUENISIMO, cómo pondría yo ese tipo de información en el repo?

También tomé en una introducción a Angular en youtube.


Se me ocurre

Una tabla con diferentes tópicos.

Libros

Título Enlace
Lorem Ipsum Example
Lorem Ipsum Dolor Example
Lorem Ipsum Algo Example
Lorem Ipsum Super Chévere Example
Lorem Ipsum Example

Cursos

Título Enlace
Lorem Ipsum Example
Lorem Ipsum Dolor Example
Lorem Ipsum Algo Example
Lorem Ipsum Super Chévere Example
Lorem Ipsum Example

Tutoriales Pagos

Título Enlace
Lorem Ipsum Example
Lorem Ipsum Dolor Example
Lorem Ipsum Algo Example
Lorem Ipsum Super Chévere Example
Lorem Ipsum Example

Tutoriales Gratuitos

Título Enlace
Lorem Ipsum Example
Lorem Ipsum Dolor Example
Lorem Ipsum Algo Example
Lorem Ipsum Super Chévere Example
Lorem Ipsum Example
@Villanuevand
Copy link
Member

El objetivo principal de este repo @dianjuar es solo almacenar libros, para otros recursos tenemos 2 repos disponibles...

Puedes mirarlos y hacer las recomendaciones que desees con toda libertad.

Continuando con este repo la idea es:

Que cada miembro pueda compartir uno o varios libros desde su drive, dropbox o cualquier plataforma. Simplemente poniendo el libro en una carpeta publica y haciendo enlace a ella en este repo. ¿Que tengo en mente?, pues algo asi:

Título del Libro
Autor
Enlace

Ejemplo:

Angular Router

Autor: Victor Savkin
enlace al libro

Y pudiendose separar por temática.

Angular

AngularJS

Typescript

Y así con cualquier categoria de interes,
¿Que te parece?

@dianjuar
Copy link
Member Author

Prefiero un tabla. Se lee mucho mejor.

Titulo Autor Enlace
Lorem Ipsum Example
Lorem Ipsum Example
Lorem Ipsum Example
Lorem Ipsum Example

El markdown para hacerlo es este

| Titulo | Autor | Enlace                         |
| :----- | :---- | :----------------------------- |
| Lorem  | Ipsum | [Example](https://example.com) |
| Lorem  | Ipsum | [Example](https://example.com) |
| Lorem  | Ipsum | [Example](https://example.com) |
| Lorem  | Ipsum | [Example](https://example.com) |

Súper la idea de separarlos por esas temáticas, se encuentra fácilmente el contenido a la hora de buscar


Viendo los otros repos me cuesta diferenciar éste de aquellos...

Si me preguntas, debido a la inactividad y el poco contenido que se manejan en aquellos deberían clausurarse y unificar todo el contenido en uno sólo, haciéndolo más diverso, rico y útil y fácil de mantener.

Es mi humilde opinión.

@JMEspiz
Copy link
Member

JMEspiz commented Apr 14, 2017

Yo apoyo la idea de la tabla de @dianjuar y separar por tematicas como dice @Villanuevand , se visualiza mejor y ocuparia menos espacio cuando el listado tenga un tamaño considerable.

@Villanuevand
Copy link
Member

Perfecto, tienes mucha razón es más fácil de reconocer...

Si alguno quiere hacer el file Contributing.md? @JMEspiz @dianjuar

Acá algunos puntos para considerar:

@Villanuevand
Copy link
Member

Acotación para algo que comentaste @dianjuar

Puede llegar un momento donde los repos se harán extensos, y por eso se decidió separar por temática los recursos tantos de Angular como de AngularJS.

Podemos incentivar a los miembros a que contribuyan en estos repos y mirar como evolucionan.
No está descartada ninguna de las opciones que Diego comenta.

cc @JMEspiz

@JMEspiz
Copy link
Member

JMEspiz commented Apr 15, 2017

chicos que les parece esta base para el CONTRIBUTING.md

Contribuyendo con "ng-biblioteca"

Para nosotros tú contribución es muy importante, y en pro de mantener un orden en nuestros repos hemos creado este archivo contributing.md, para que puedas enviar todos tus aportes.
Aquí están los lineamientos para poder contribuir.

Donde Contribuir:

En el archivo BIBLIOTECA.md estara el listado de libros y es donde podras hacer tus aportes. Los libros estaran dividos según su temática y presentados en una tabla de la siguiente forma:

AngularJS

Titulo Autor Enlace
Lorem Ipsum Example
Lorem Ipsum Example
Lorem Ipsum Example
Lorem Ipsum Example

Angular

Titulo Autor Enlace
Lorem Ipsum Example
Lorem Ipsum Example
Lorem Ipsum Example
Lorem Ipsum Example

TypeScript

Titulo Autor Enlace
Lorem Ipsum Example
Lorem Ipsum Example
Lorem Ipsum Example
Lorem Ipsum Example

Este seria el MarkDown para las tablas:

| Titulo | Autor | Enlace                         |
| :----- | :---- | :----------------------------- |
| Lorem  | Ipsum | [Example](https://example.com) |
| Lorem  | Ipsum | [Example](https://example.com) |
| Lorem  | Ipsum | [Example](https://example.com) |
| Lorem  | Ipsum | [Example](https://example.com) |

Los libros estarán ordenados por orden alfabético para mayor comodidad y facilidad de busqueda, asegúrate de agregar tu aporte en el lugar correspondiente. :D

Formato de Commits

Tenemos una estructura a seguir, para facilitar la validación de tus contribuciones y mantener un buen flujo de trabajo. Los mensajes de commits deberían ser de la siguiente manera:

(<Accion>): <Mensaje Corto>
<LINEA EN BLANCO>
<Mensaje Explicativo>

El Encabezado: (<Accion>): <Mensaje Corto> es obligatorio, el resto es opcional. Las acciones disponibles, puedes encontralas en Acciones, un poco más abajo.

Cualquier línea en un mensaje de commit no de ser mayor de 100 caracteres!. Esto permite la fácil lectura de los mensajes tanto en Github como en varias herramientas de git.

Ejemplos:

Commit Corto:

(Agrega): Rangle's Angular Training Book

Commit Largo:

(Agrega): Rangle's Angular Training Book.

Libro desarrollado por Rangle.io como parte
de su material en su curso de formacion sobre
Angular.

Nota: Por favor antes de enviar tu aporte es importante que leas y respetes el Disclaimer. Si tienes alguna duda puedes crear un Issue en el repositorio y los demás miembros de la comunidad podrían orientarte al respecto.

Acciones

Las acciones son los indicativos primordiales de los cambios que realizamos en un determinado archivo. Con éstas lo que intentamos es saber con una simple lectura que tipo de modificació fué hecha.
Actualmente tenemos estás acciones disponibles:

  • Agrega: Usalo para notificar una nuevo libro al listado existente.
  • Elimina: Cuando eliminas algun libro que al este violando derechos de autor y/o distribución.
  • Correccion: Si existe un typo en algún título de los libros o enlaces rotos.

Disclaimer

Todos los libros en este repositorio son contribuciones y recomendaciones de los miembros de la comunidad. Apreciamos todas las contribuciones a ng-biblioteca, sin embargo, asegúrate que tu aporte no viole ningún derecho de autor y/o distribución del libro que estés recomendando.

@Villanuevand
Copy link
Member

¡Perfecto! @JMEspiz
cc @dianjuar

@Villanuevand
Copy link
Member

Pendiente cuando vayas hacer el file, seguir los lineamientos de github.

@dianjuar
Copy link
Member Author

@JMEspiz está todo super.
Te encargas del PR?

@dianjuar
Copy link
Member Author

@JMEspiz hay un termino en spanglish...

Corrección: Si existe un typo en algún título de los libros o enlaces rotos.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants