Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
SergioRibera authored Nov 4, 2024
0 parents commit 31681d6
Show file tree
Hide file tree
Showing 20 changed files with 1,430 additions and 0 deletions.
31 changes: 31 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: bug
assignees: SergioRibera

---

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

**Expected behavior**
A clear and concise description of what you expected to happen.

**Screenshots**
If applicable, add screenshots to help explain your problem.

**Desktop (please complete the following information):**
- OS: [e.g. NixOS 24.05 (Uakari)]
- Wrangler Version [e.g. 3.28.3]

**Additional context**
Add any other context about the problem here.
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: enhancement
assignees: ''

---

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
Add any other context or screenshots about the feature request here.
30 changes: 30 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# Descripción

Incluye un resumen de los cambios y el problema relacionado. Por favor, incluye también la motivación y el contexto relevante. Lista cualquier dependencia que se requiera para este cambio.

Soluciona el problema # (issue)

## Tipo de cambio

Por favor, elimina las opciones que no sean relevantes.

- [ ] Corrección de error (cambio que no rompe la funcionalidad existente y que soluciona un problema)
- [ ] Nueva característica (cambio que no rompe la funcionalidad existente y que añade una nueva funcionalidad)
- [ ] Cambio importante (corrección o característica que podría causar que la funcionalidad existente no funcione como se espera)
- [ ] Este cambio requiere una actualización de la documentación

# ¿Cómo se ha probado esto?

Por favor, describe las pruebas que realizaste para verificar tus cambios. Proporciona instrucciones para que podamos reproducirlas. También lista cualquier detalle relevante para la configuración de tus pruebas.

- [ ] Prueba A
- [ ] Prueba B

# Lista de verificación:

Elimina si no es relevante

- [ ] He realizado una auto-revisión de mi código
- [ ] He realizado los cambios correspondientes en la documentación
- [ ] He actualizado el entorno nix
- [ ] Mi codigo pasó todas las pruebas
29 changes: 29 additions & 0 deletions .github/pull_request_template_en.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Description

Please include a summary of the changes and the related issue. Please also include relevant motivation and context. List any dependencies that are required for this change.

Fixes # (issue)

## Type of change

Please delete options that are not relevant.

- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
- [ ] This change requires a documentation update

# How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

- [ ] Test A
- [ ] Test B

# Checklist:

Remove if not relevant

- [ ] I have performed a self-review of my code
- [ ] I have made corresponding changes to the documentation
- [ ] I have made updated the nix environment
45 changes: 45 additions & 0 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
name: Deploy to Cloudflare

on:
workflow_dispatch:
push:
branches:
- main
paths:
- ".github/workflows/deploy.yml"
- "wrangler.toml"
- "src/**/**.rs"
- "Cargo.toml"
- "Cargo.lock"
- "rust-toolchain.toml"

jobs:
quality-gate:
uses: ./.github/workflows/quality-gate.yml
with:
checks-command: "--all --check"
clippy-command: "-- -D warnings"
tests-command: "test"

deploy:
needs: [quality-gate]
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- uses: dtolnay/rust-toolchain@stable
- uses: Swatinem/rust-cache@v2
- name: Install worker-build
run: |
cargo install worker-build
- name: Deploy
uses: cloudflare/wrangler-action@v3
# env:
# YOUR_SECRET: ${{ secrets.YOUR_SECRET }}
# YOUR_OTHER_SECRET: ${{ secrets.YOUR_OTHER_SECRET }}
with:
apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
# secrets: |
# YOUR_SECRET
# YOUR_OTHER_SECRET
28 changes: 28 additions & 0 deletions .github/workflows/quality-gate.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
name: Quality Gate
on:
workflow_call:
inputs:
checks-command:
required: true
type: string
clippy-command:
required: true
type: string
tests-command:
required: true
type: string
workflow_dispatch:
pull_request:
paths:
- "src/**/**.rs"
schedule:
- cron: '0 0 1 * *'

jobs:
quality-gate:
uses: RustLangES/.github/.github/workflows/quality-gate.yml@main
with:
runs-on: ubuntu-latest
checks-command: ${{ inputs.checks-command }}
clippy-command: ${{ inputs.clippy-command }}
tests-command: ${{ inputs.tests-command }}
8 changes: 8 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
/target
/build
/node_modules
/.wrangler
/result
**/*.rs.bk
wasm-pack.log
.dev.vars
39 changes: 39 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# Contribuyendo al Proyecto

¡Gracias por tu interés en contribuir a este proyecto! A continuación, se detallan las pautas para contribuir de manera efectiva.

## Código de Conducta

Al participar en este proyecto, se espera que sigas nuestro [Código de Conducta](LINK_AL_CODIGO_DE_CONDUCTA). Por favor, léelo y respétalo en todas tus interacciones.

## Problemas

Si encuentras un problema o tienes una sugerencia para mejorar el proyecto, puedes abrir un nuevo issue en el repositorio. Por favor, proporciona detalles claros y concisos sobre el problema o la sugerencia.

## Solicitudes de Extracción (Pull Requests)

1. Realiza un fork del repositorio y crea una nueva rama para tus cambios.
2. Realiza tus modificaciones y asegúrate de que el código siga las pautas de estilo y las pruebas pasen.
3. Escribe pruebas para tu código nuevo o actualizado.
4. Actualiza la documentación si es necesario.
5. Crea una solicitud de extracción desde tu rama hacia la rama principal del repositorio original.
6. Proporciona una descripción clara y concisa de tus cambios.
7. Asegúrate de que tu solicitud de extracción pase todas las pruebas y revisiones de código requeridas.

## Estilo de Código

Este proyecto sigue las pautas de estilo de código de Rust. Por favor, asegúrate de que tus contribuciones cumplan con estas pautas.

## Pruebas

Todas las contribuciones deben incluir pruebas para garantizar la calidad del código. Asegúrate de que tus pruebas cubran los casos de uso relevantes y de que pasen antes de enviar una solicitud de extracción.

## Documentación

Si tu contribución implica cambios en la documentación, por favor, actualízala acorde a tus cambios. Mantener una documentación clara y actualizada es fundamental para la comprensión y el mantenimiento del proyecto.

## Licencia

Al contribuir a este proyecto, aceptas que tus contribuciones se licencien bajo la [LICENCIA MIT](./LICENSE-MIT) del proyecto.

¡Gracias por tu interés en contribuir a este proyecto! Esperamos con ansias tus contribuciones.
39 changes: 39 additions & 0 deletions CONTRIBUTING_EN.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# Contributing to the Project

Thank you for your interest in contributing to this project! Below are the guidelines for contributing effectively.

## Code of Conduct

When participating in this project, it is expected that you follow our [Code of Conduct](LINK_TO_CODE_OF_CONDUCT). Please read it and respect it in all your interactions.

## Issues

If you find a bug or have a suggestion to improve the project, you can open a new issue in the repository. Please provide clear and concise details about the problem or suggestion.

## Pull Requests (PRs)

1. Fork the repository and create a new branch for your changes.
2. Make your modifications and ensure that the code follows style guidelines and all tests pass.
3. Write tests for your new or updated code.
4. Update the documentation if necessary.
5. Create a pull request from your branch to the main branch of the original repository.
6. Provide a clear and concise description of your changes.
7. Ensure that your pull request passes all required tests and code reviews.

## Code Style

This project follows Rust's code style guidelines. Please ensure that your contributions adhere to these guidelines.

## Tests

All contributions must include tests to ensure code quality. Make sure your tests cover relevant use cases and pass before submitting a pull request.

## Documentation

If your contribution involves changes to the documentation, please update it accordingly. Keeping documentation clear and up-to-date is crucial for understanding and maintaining the project.

## License

By contributing to this project, you agree that your contributions will be licensed under the [MIT LICENSE](./LICENSE-MIT) of the project.

Thank you for your interest in contributing to this project! We look forward to your contributions.
Loading

0 comments on commit 31681d6

Please sign in to comment.