-
Notifications
You must be signed in to change notification settings - Fork 38
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'main' into docs/hosting-page
- Loading branch information
Showing
5 changed files
with
113 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
--- | ||
title: Contribuciones | ||
description: Cómo ayudar en el desarrollo de go-fast-cdn. | ||
--- | ||
|
||
## Go-fast CDN | ||
|
||
Puedes acceder al código fuente en [Github](https://github.com/kevinanielsen/go-fast-cdn/), donde se anima a todos a contribuir de cualquier manera posible para mejorar este proyecto. Aunque es posible que no puedas contribuir a las características de este proyecto, aún puedes contribuir escribiendo pruebas, corrigiendo errores o incluso corrigiendo errores tipográficos. | ||
|
||
Si eso no es posible, aún puedes ayudar contribuyendo a la [Documentación](#documentation). Incluso solo dejar una estrella o compartir el proyecto es una excelente manera de contribuir. | ||
|
||
Si deseas informar un error o solicitar una nueva característica, puedes crear un nuevo problema en GitHub, donde se proporciona una plantilla y se anima a su uso. Si deseas corregir un error o implementar una nueva característica, adelante y abre una solicitud de extracción con tu propuesta. | ||
|
||
Por favor, lee la [Guía de Desarrollo](/go-fast-cdn/contribution/development) para obtener más información sobre cómo desarrollar en este proyecto. | ||
|
||
### Commits | ||
|
||
Este proyecto sigue las [convenciones de @commitlint](https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/config-conventional) y pedimos que por favor hagas lo mismo en la medida de lo posible. Lo más importante es agregar un tipo de commit que debe ser uno de los siguientes: | ||
|
||
- **build** - cambios relacionados con la compilación | ||
- **chore** - cambios no cubiertos por otros tipos | ||
- **ci** - cambios relacionados con CI/CD | ||
- **docs** - cambios relacionados con la documentación | ||
- **feat** - nuevas características | ||
- **fix** - correcciones de errores | ||
- **perf** - cambios que mejoran el rendimiento | ||
- **refactor** - cambios que mejoran el rendimiento | ||
- **revert** - revirtiendo a commits anteriores | ||
- **style** - cambios relacionados con el estilo | ||
- **test** - cambios relacionados con las pruebas | ||
|
||
Un ejemplo de un mensaje de commit siguiendo esta convención podría ser: | ||
|
||
```txt | ||
docs: add commit-convention to contribution guide | ||
``` | ||
|
||
Para especificar aún más qué está cambiando tu commit, puedes agregar un alcance con paréntesis, así: | ||
|
||
```txt | ||
feat(api): add endpoint for file uploads | ||
``` | ||
|
||
## Documentación | ||
|
||
[Github](https://github.com/kevinanielsen/go-fast-cdn/) Es un monorepo, donde la documentación se encuentra en el directorio /docs. Si deseas solicitar documentación para una característica, adelante y crea un nuevo problema en Github. Si tienes la solución para un problema o quieres editar la documentación, adelante y haz un fork del proyecto, y cuando estés listo, abre una nueva solicitud de extracción. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,55 @@ | ||
--- | ||
title: Desarrollo | ||
description: Cómo ayudar a desarrollar go-fast-cdn. | ||
--- | ||
|
||
## Instalación | ||
|
||
### Clonando el repositorio | ||
|
||
Puedes clonar este repositorio con alguno de los siguientes comandos: | ||
|
||
```bash title="SSH" | ||
git clone git@github.com:kevinanielsen/go-fast-cdn | ||
``` | ||
|
||
```bash title="HTTPS" | ||
git clone https://github.com:kevinanielsen/go-fast-cdn | ||
``` | ||
|
||
### Configurando el proyecto | ||
|
||
Este proyecto utiliza [dotenv](https://dotenv.org) y puedes acceder al `.env.example` [aquí](https://vault.dotenv.org/project/vlt_a602c18fc8f8fd898bfacba2ed8715a9deca301c87e06fbb3ea2cde40c41e109/example). | ||
Puedes copiar eso y pegarlo en tu archivo `.env`. | ||
|
||
## Compilación | ||
|
||
Este proyecto utiliza un Makefile, y puedes usarlo para construir los binarios. | ||
|
||
```bash | ||
make prep # Instalar dependencias | ||
make clean # Limpiar los archivos de salida (no utilices si es la primera vez que construyes) | ||
make build # Compilar los binarios. | ||
``` | ||
|
||
Esto compilará cruzadamente los binarios para Windows, Darwin y Linux, así que asegúrate de tener los compiladores instalados en tu máquina si ejecutas `make build`. Si no tienes el compilador instalado, en su lugar ejecuta: | ||
|
||
```bash | ||
go build . | ||
``` | ||
|
||
### Ejecución | ||
|
||
Tu binario debería estar construido ahora y puedes ejecutarlo con uno de los siguientes comandos, dependiendo de tu sistema: | ||
|
||
```sh title="Windows" | ||
.\bin\go-fast-cdn-windows | ||
``` | ||
|
||
```bash title="MacOS" | ||
/bin/go-fast-cdn-darwin | ||
``` | ||
|
||
```bash title="Linux" | ||
/bin/go-fast-cdn-linux | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
--- | ||
title: Uso | ||
description: Cómo usar go-fast-cdn. | ||
--- | ||
|
||
Go-fast CDN tiene una interfaz muy fácil de usar que se servirá en la raíz de la aplicación. (Si se ejecuta en tu máquina, será [localhost:8080](http://localhost:8080/)) | ||
|
||
## API | ||
|
||
Por supuesto, también puedes acceder a la CDN de forma programática utilizando la API. La documentación de la API está actualmente disponible [aquí](https://go-fast-cdn.stoplight.io/docs/go-fast-cdn/ko06k96f2hywu-go-fast-cdn). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters