Skip to content
This repository has been archived by the owner on Jun 13, 2022. It is now read-only.

Commit

Permalink
feat(docs): improve the Contribution Guide
Browse files Browse the repository at this point in the history
  • Loading branch information
Patricia Mora committed Nov 22, 2018
1 parent 4d562f0 commit 1d9bcdd
Show file tree
Hide file tree
Showing 2 changed files with 92 additions and 22 deletions.
58 changes: 47 additions & 11 deletions packages/docs/src/contributing/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,29 +5,41 @@ sidebarDepth: 3

# Contribution Guide

Any contribution to Statusfy is more than welcome!
Statusfy is one of the [Bazzite's][bazzite-home] Open Source Projects that is under very active development. We hope this document makes the process for contributing clear and answers some questions that you may have.

::: tip IMPORTANT
Please make sure to read our [Code of Conduct][code-of-conduct] before making a contribution.
:::

Statusfy relies on three Amazing Technologies:
First, you must know that Statusfy relies on three Amazing Technologies:

- **[Vue.js][vue]:** Dynamically defines the interfaces that represent the data.
- **[Nuxt.js][nuxt]:** A quickly, flexible and useful abstraction of the client and server logic. It also generates/builds the application.
- **[Tailwind CSS][tailwind]:** A utility CSS framework that defines the styles in a smart way.

***Any contribution is more than welcome!***

## Code of Conduct

We have adopted a Code of Conduct that we expect project participants to adhere to. Please read [the full text][code-of-conduct] so that you can understand what actions will and will not be tolerated.

## Semantic Versioning

Bazzite follows [semantic versioning][semantic-versioning]. We release **patch versions** for bugfixes, **minor versions** for new features, and **major versions** for any breaking changes.

Every significant change is documented in the [changelog][changelog] file.

## Reporting Issues

A great way to contribute to the project is to send a detailed report when you encounter an issue. We use the [Github Issues section][github-issues] for these reports.

Please make sure to include a reproduction repository. We can start fixing bugs faster if you provide a project for reproduction.

## Pull Requests
## Proposing a Change

Any significant improvement (no matter if it's just to fix a typo) should be associated with a [feature request][feature-request] or [bug report][bug-report]. If you require Professional Support on your project(s) or want to ask general questions, just go to our [Support Page][support-page].

### Pull Requests

Any significant improvement (no matter if it's just to fix a typo) should be associated with a [feature request][feature-request] or [bug report][bug-report]. If you require Professional Assistance on your project(s) or want to ask general questions, just go to our [Support Page][support-page].
If you intend to add a new feature, we recommend filing [an issue][github-issues]. This lets us reach an agreement on your proposal before you put significant effort into it.

### Getting started
#### Getting started

Install [Node.js][node] (8.1 or higher) and [Yarn][yarn]. It's also recommended to install [Lerna][lerna] globally.

Expand All @@ -40,7 +52,7 @@ To use **@statusfy/cli** in the repo as a global command. Enter the `./packages/

The Statusfy repository is a [monorepo][monorepo] with multiple [sub-projects/packages](#packages). Before sending a pull request, you should know the task of each sub-project [bellow](#packages).

### Tests
### Testing

A great **Pull Request** will often include tests. To write great tests, we explain you our testing structure:

Expand Down Expand Up @@ -81,11 +93,28 @@ You don't have to write documentation up immediately (but please do so as soon a

We're open to any contribution that translates the Statusfy core to other languages. Just use as a base language [this file][english-language] and translate the strings. The new file you create must follow this pattern `lang-default.json` where `lang` is the identification of the language in a two-letter representation (in [ISO 639-1][iso-639-1] format) with an optional region (in [ISO 3166-1 Alpha 2][iso-3166-1-alpha-2] format).

### Contributor License Agreement (CLA)

In order to accept your pull request, we need you to submit a CLA. You only need to do this once. **By signing a contributor license agreement, we ensure that the community is free to use your contributions.**

[**Complete your CLA here.**][cla]

### Final checklist

When submitting your **Pull Request**, there is a simple template that you have to fill out. Please tick all suitable answers in the checklists.

## Packages
## License

By contributing to Statusfy, you agree that your contributions will be licensed under its [Apache 2.0][license].


## Financial Contribution

We love Open Source Projects, we use them every day and **Statusfy is our contribution to the Community**, but our resources are limited. If you want to support our work and help us to continue developing this Amazing Project, please donate, we will appreciate it ❤️.

[**Become a Backer, Sponsor or Partner on OpenCollective.**][open-collective]

## Project Structure

Statusfy is a completely opensource project, its repository is a monorepo with multiple sub-projects/packages located at the `./packages` folder.

Expand Down Expand Up @@ -176,3 +205,10 @@ It's a simple [Nuxt.js][nuxt] application.
[markdown-it]: https://github.com/markdown-it/markdown-it
[vue]: http://vuejs.org/
[tailwind]: https://tailwindcss.com/
[semantic-versioning]: https://semver.org/
[bazzite-home]: https://www.bazzite.com?utm_source=docs&utm_medium=contributing&utm_campaign=statusfy
[changelog]: https://github.com/bazzite/statusfy/blob/master/CHANGELOG.md
[examples]: https://github.com/bazzite/statusfy-examples
[cla]: https://cla.bazzite.com/bazzite/statusfy
[license]: https://github.com/bazzite/statusfy/blob/develop/LICENSE
[open-collective]: https://bazzite.xyz/StatusfyOpenCollective#contribute
56 changes: 45 additions & 11 deletions packages/docs/src/es/contributing/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,29 +5,41 @@ sidebarDepth: 3

# Guía de Contribución

Cualquier contribución a Statusfy es más que bienvenida!
Statusfy es uno de los proyectos de código abierto de [Bazzite][bazzite-home] que está en activo desarrollo. Esperamos que este documento haga que el proceso de contribución sea claro y que responda algunas preguntas que puedas tener.

::: tip IMPORTANTE
Asegúrate de leer nuestro [Código de Conducta][code-of-conduct] antes de hacer una contribución.
:::

Statusfy se basa en tres tecnologías asombrosas:
Primero, es importante saber que Statusfy se basa en tres tecnologías asombrosas:

- **[Vue.js][vue]:** Define dinámicamente las interfaces que representan los datos.
- **[Nuxt.js][nuxt]:** Una abstracción rápida, flexible y útil de la lógica del cliente y del servidor. También genera/construye la aplicación.
- **[Tailwind CSS][tailwind]:** Un Framework CSS de utilidad que define los estilos de una manera inteligente.

***Cualquier contribución a Statusfy es más que bienvenida!***

## Código de Conducta

Hemos adoptado un Código de Conducta que esperamos que los participantes del proyecto cumplan. Lee [el texto completo][code-of-conduct] para que puedas comprender qué acciones serán o no toleradas.

## Versionado Semántico

Bazzite sigue [el Versionado Semántico][semantic-versioning]. Lanzamos **versiones patch** para correcciones de errores, **versiones minor** para nuevas funcionalidades y **versiones major** para cualquier cambio importante.

Cada cambio significativo se documenta en el archivo de [registro de cambios][changelog].

## Reporte de Incidencia

Una excelente manera de contribuir al proyecto es enviar un reporte detallado cuando se encuentra con un problema. Utilizamos la [sección de Issues de Github][github-issues] para estos reportes.

Por favor, asegúrate de incluir un repositorio de reproducción. Podemos comenzar a corregir errores más rápido si proporcionas un proyecto para su reproducción.

## Pull Requests
## Proponer un Cambio

Cualquier mejora significativa (no importa si es solo para corregir un error tipográfico) debe asociarse con una [solicitud de nueva funcionalidad][feature-request] o un [reporte de error][bug-report].

### Primeros Pasos
### Pull Requests

Si deseas agregar una nueva funcionalidad, te recomendamos que abras un [issue][github-issues]. Esto nos permite llegar a un acuerdo sobre tu propuesta antes de ponerle un gran esfuerzo.

#### Primeros Pasos

Installa [Node.js][node] (8.1 o superior) y [Yarn][yarn]. También se recomienda instalar [Lerna][lerna] a nivel global.

Expand Down Expand Up @@ -83,11 +95,27 @@ No tienes que escribir la documentación inmediatamente (pero házlo tan pronto

Estamos abiertos a cualquier contribución que traduzca el núcleo de Statusfy a otros idiomas. Solo usa como idioma base [este archivo][english-language] y traduce las cadenas. El nuevo archivo que se cree debe seguir este patrón `lang-default.json` donde `lang` es la identificación del idioma en una representación de dos letras (en format [ISO 639-1][iso-639-1]) con una región opcional (en formato [ISO 3166-1 Alpha 2][iso-3166-1-alpha-2]).

### Lista de verificación final
### Acuerdo de Licencia de Colaborador (CLA)

Para aceptar tu pull request, necesitamos que envíes un CLA. Sólo necesitas hacer esto una vez. **Al firmar un cuerdo de Licencia de Colaborador, nos aseguramos de que la comunidad sea libre de utilizar tus contribuciones.**

[**Completa tu CLA aquí**][cla](sólo disponible in Inglés).

### Verificación final

Al enviar tu **Pull Request**, hay una plantilla simple que debes completar. Por favor, marcas todas las respuestas adecuadas en las listas de verificación.

## Paquetes
## License

By contributing to Statusfy, you agree that your contributions will be licensed under its [Apache 2.0][license].

## Contribución Financiera

Nos encantan los Proyectos de Código Abierto, los usamos todos los días y **Statusfy es nuestra contribución a la Comunidad**, pero nuestros recursos son limitados. Si deseas apoyar nuestro trabajo y ayudarnos a continuar desarrollando este Proyecto Íncreíble, puedes hacer una donación, lo apreciaremos ❤️.

[**Conviértete en un Backer, Patrocinador o Socio en OpenCollective.**][open-collective]

## Estructura del Proyecto

Statusfy es un proyecto completamente abierto, tu repositorio es un monorepo con múltiples subproyectos/paquetes ubicados en la carpeta `./packages`.

Expand Down Expand Up @@ -181,4 +209,10 @@ Es una aplicación [Nuxt.js][nuxt] simple.
[markdown-it]: https://github.com/markdown-it/markdown-it
[vue]: http://vuejs.org/
[tailwind]: https://tailwindcss.com/

[semantic-versioning]: https://semver.org/lang/es/
[bazzite-home]: https://www.bazzite.com/es?utm_source=docs&utm_medium=contributing&utm_campaign=statusfy
[changelog]: https://github.com/bazzite/statusfy/blob/master/CHANGELOG.md
[examples]: https://github.com/bazzite/statusfy-examples
[cla]: https://cla.bazzite.com/bazzite/statusfy
[license]: https://github.com/bazzite/statusfy/blob/develop/LICENSE
[open-collective]: https://bazzite.xyz/StatusfyOpenCollective#contribute

0 comments on commit 1d9bcdd

Please sign in to comment.