Skip to content

Commit 05e2c6d

Browse files
authored
Merge pull request #15 from python-chile/pch-feature-14-archivo-contributing
Creación archivo contributing
2 parents 3e42c52 + 5e2bda4 commit 05e2c6d

File tree

2 files changed

+57
-0
lines changed

2 files changed

+57
-0
lines changed

CONTRIBUTING.md

+53
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
# Contribución PyAtlas
2+
3+
---
4+
5+
Reglas que se deben seguir para poder aportar al proyecto, bajo las [normas](https://github.com/python-chile/docs/blob/master/normativa-trabajo-github.md) de Python Chile. Favor seguir el paso a paso, cualquier aporte que no siga las bases es rechazado.
6+
7+
Se compone de tres tópicos, descritos a continuación, cada uno abarca un objetivo específico para crecer el proyecto de forma ordenada.
8+
9+
**Importante**: Todo aporte al proyecto y discusión se exige que sea de forma respetuosa hacia integrantes del proyecto.
10+
11+
---
12+
13+
## Contribución relacionado con una Issue
14+
Para el caso que haya una issue creada y bajo esta se hace un aporte, basarse en lo siguiente:
15+
16+
### Issue
17+
- La creación de una issue sólo está permitido para el caso en que se detecte algún bug, error, falla o corrección que se deba hacer en el proyecto, dicha corrección por ejemplo, puede ser eliminar o actualizar algún elemento de la lista. Esta issue debe contar con su respectiva descripción.
18+
- Cualquier persona puede crear una issue, como también se puede asignar una issue para resolverla, creada por si mismo o por terceros.
19+
20+
### Pull Request
21+
- Debe existir de forma previa su correspondiente issue.
22+
- Se debe enlazar dicha issue en la pull request.
23+
- Debe contener una breve descripción del aporte.
24+
- Respetar revisión y tiempos de codeowners.
25+
- Debe contener al menos una aprobación, cualquier cambio que se pida, se anula la(s) aprobacion(es) previa(s).
26+
- Merge y squash para finalizar la pull request.
27+
28+
### Nomenclatura rama
29+
- Debe seguir el formato pch-< tipo >-< número issue >-< breve titulo > ejemplo: `pch-fix-34-enlaces-libs-data`
30+
- Tener en consideración:
31+
- Tipo: Puede ser fix o feature.
32+
- Breve título: Una descripción relacionado con la issue.
33+
34+
## Contribución sin una issue relacionada
35+
Para el caso de aportes simples que sólo agregar elementos a la lista, basarse en lo siguiente:
36+
37+
### Pull request
38+
- Debe contener sólo nuevos elementos que se agregan a la lista, se debe respetar todos los campos, nombre, enlace, descripción y tipo.
39+
- Se puede agregar tantos elementos como se quiera, no es necesario que pertenezcan a un mismo tipo estos elementos, es decir, se puede agregar librerías, frameworks u otros al mismo tiempo.
40+
- Opcionalmente puede contener una descripción.
41+
- Se debe respetar revisión y tiempos de codeowners.
42+
- Debe contener al menos una aprobación, cualquier cambio nuevo, anula la mínima aprobación previa.
43+
44+
### Nomenclatura rama
45+
- Debe seguir el formato pch-< tipo >-< breve titulo > ejemplo: `pch-feature-framworks-web`
46+
- Tener en consideración:
47+
- Tipo: Debe ser feature
48+
- Breve título: Descripción breve, no es necesario que sea descriptivo en su totalidad ya que dentro de esta puede haber un mix de libs, tools, u otros que no tengan une relación para ser abarcados en el título.
49+
50+
## Discussion
51+
Necesario para el caso de nuevas ideas que se quieran agregar al proyecto, puede ser, flujo de trabajo, mejorar formato de la lista, actualizar la tabla simbología del proyecto, proposición de una mejora del proyecto en general,
52+
en resumen, cualquier tema que no pertenezca a una issue o agregar elementos a la lista.
53+
La creación de un _discussion_ debe contener su correspondiente tag.

README.md

+4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
# pyAtlas 🗺️
22
Proyecto para recopilar libs, tools, otros, relacionado con Python en un archivo simple.
33

4+
---
5+
## Para contribuir 🤝
6+
Seguir las normas definidas en archivo CONTRIBUTING.md
7+
48
---
59

610
## Simbología

0 commit comments

Comments
 (0)