diff --git a/CODE_OF_CONDUCT-es.md b/CODE_OF_CONDUCT-es.md new file mode 100644 index 0000000..a1f38a5 --- /dev/null +++ b/CODE_OF_CONDUCT-es.md @@ -0,0 +1,53 @@ +# Código de Conducta convenido para Contribuyentes + +## Nuestro compromiso + +En el interés de fomentar una comunidad abierta y acogedora, nosotros como contribuyentes y administradores nos comprometemos a hacer de la participación en nuestro proyecto y nuestra comunidad una experiencia libre de acoso para todos, independientemente de la edad, dimensión corporal, discapacidad, etnia, identidad y expresión de género, nivel de experiencia, nacionalidad, apariencia física, raza, religión, identidad u orientación sexual. + +## Nuestros estándares + +Ejemplos de comportamiento que contribuyen a crear un ambiente positivo: + +* Uso de lenguaje amable e inclusivo +* Respeto a diferentes puntos de vista y experiencias +* Aceptación de críticas constructivas +* Enfocarse en lo que es mejor para la comunidad +* Mostrar empatía a otros miembros de la comunidad + +Ejemplos de comportamiento inaceptable por participantes: + +* Uso de lenguaje o imágenes sexuales y atención sexual no deseada +* Comentarios insultantes o despectivos (*trolling*) y ataques personales o políticos +* Acoso público o privado +* Publicación de información privada de terceros sin su consentimiento, como direcciones físicas o electrónicas +* Otros tipos de conducta que pudieran considerarse inapropiadas en un entorno profesional. + +## Nuestras responsabilidades + +Los administradores del proyecto son responsables de clarificar los estándares de comportamiento aceptable y se espera que tomen medidas correctivas y apropiadas en respuesta a situaciones de conducta inaceptable. + +Los administradores del proyecto tienen el derecho y la responsabilidad de eliminar, editar o rechazar comentarios, *commits*, código, ediciones de documentación, *issues*, y otras contribuciones que no estén alineadas con este Código de Conducta, o de prohibir temporal o permanentemente a cualquier colaborador cuyo comportamiento sea inapropiado, amenazante, ofensivo o perjudicial. + +## Alcance + +Este código de conducta aplica tanto a espacios del proyecto como a espacios públicos donde un individuo esté en representación del proyecto o comunidad. Ejemplos de esto incluye el uso de la cuenta oficial de correo electrónico, publicaciones a través de las redes sociales oficiales, o presentaciones con personas designadas en eventos *online* u *offline*. La representación del proyecto puede ser clarificada explicitamente por los administradores del proyecto. + +## Aplicación + +Ejemplos de abuso, acoso u otro tipo de comportamiento inaceptable puede ser reportado al equipo del proyecto en [support@nostalgi.cc][support-email]. Si no deseas contactar a todo el equipo, siéntete libre de contartar a cualquiera de manera individual: + +* B. C. Rikko <[bcrikko@example.com](mailto:b.c.rikko@gmail.com)> +* Igor Guastalla <[limaguastallaigor@gmail.com](mailto:limaguastallaigor@gmail.com)> +* Trezy <[tre@trezy.com](mailto:tre@trezy.com)> + +Todas los reportes serán revisadas e investigadas, lo que resultará en una respuesta adecuada a las necesidades y circunstancias. El equipo del proyecto está obligado a mantener confidencialidad de la persona que reportó el incidente. Detalles específicos acerca de las políticas de aplicación pueden ser publicadas por separado. + +Administradores que no sigan o que no hagan cumplir este Código de Conducta pueden ser eliminados de forma temporal o permanente del equipo administrador. + +## Atribución + +Este Código de Conducta es una adaptación del [Contributor Covenant][homepage], versión 1.4, disponible en https://www.contributor-covenant.org/es/version/1/4/code-of-conduct.html + +[homepage]: https://www.contributor-covenant.org +[support-email]: mailto:support@nostalgi.cc +[version]: http://contributor-covenant.org/version/1/4/ diff --git a/CONTRIBUTING-es.md b/CONTRIBUTING-es.md new file mode 100644 index 0000000..d1d422c --- /dev/null +++ b/CONTRIBUTING-es.md @@ -0,0 +1,99 @@ +# Contribución + +¿Quieres contribuir al proyecto? ¡Genial! + +## Cosas que tienes que saber + +Este proyecto se apega al Código de Conducta convenido para Contribuyentes. Al participar, se espera que te apegues a este código. Por favor, revisa nuestro [Código de Conducta][code-of-conduct] para más información acerca de reportar comportamiento no apropiado. + +**¿Trabajando en tu primer Pull Request?** +[Cómo contribuir a un proyecto de código abierto en GitHub][egghead] + +## Cómo + +* ¿Configuración del proyecto? + [¡Te tenemos cubierto!](#project-setup) + +* ¿Encontraste un bug? + [¡Házlono saber!][new-issue] + +* ¿Arreglaste un bug? + [¡Haz un PR!][new-pr] + +* ¿Agregando una nueva característica? + Asegúrate de [abrir un issue][new-issue] describiendo tu característica o mejora, ¡Después abre un [nuevo PR][new-pr] cuando estés listo para recibir retroalimentación! + +## Configuración del proyecto + +¡Estamos muy felices porque quieras contribuir al proyecto! ❤️ Los siguientes pasos te ayudarán a poner el proyecto en marcha: + +1. Haz un Fork y Clon del repositorio. +2. Instala las dependencias necesarias: + ```sh + $ npm install + ``` +3. Ejecuta el servidor de desarrollo: + ```sh + $ npm run storybook + ``` + +### Directorios +```sh +. +├── index.html: Página demo +├── style.css: Estilo de la página demo +├── css: Archivos de distribución +├── docs: Storybook stories +└── scss: Código fuente + ├── base + │ ├── reboot.scss: ¡No cambiar! (Bootstrap Reboot) + │ ├── generic.scss: Estilo general y reboot.css + │ └── variables.scss: Variables comunes + ├── elements + ├── form + ├── icons: Iconos 16x16 + ├── pixel-arts: Para iconos que no son 16x16. + └── utilities +``` + +> Tip: Manten tu rama `master` apuntando al repositorio original y haz pull request de las ramas en tu fork. Para hacer esto, ejecuta: +> +> ``` +> git remote add upstream https://github.com/nostalgic-css/NES.css.git +> git fetch upstream +> git branch --set-upstream-to=upstream/master master +> ``` +> +> Esto añadirá el repositorio original como un "remoto" llamado "upstream", *fetch* la información de git desde el remoto, y configura tu rama local `master` para utilizar la rama `upstream/master` cuando ejecutes `git pull`. En este punto, tú puedes crear todas tus ramas desde esta rama `master`. Cuando quieras actualizar tu versión de `master`, haz un `git pull`. + +## Contribución para miembros de la organización `nostalgic-css` + +Debajo hay pasos, los cuales deben ser seguidos por los miembros de `nostalgic-css`. Colaboradores externos sólo tienen que seguir los pasos anteriores. + +### Pasos para desarrollo + +1. Haz una rama desde `develop` utilizando las siguientes reglas de tomato. +2. Haz el trabajo para resolver el *issue*. Si identificas trabajo que no está relacionado con el *issue*, por favor [crea un nuevo issue][new-issue] y haz el trabajo en una rama independiente. +3. Envía tus PRs a hacer *merge* en `develop`. + * Todo cambio que pueda afectar el desarrollo actual deberá ser documentado en la descripción. + * PRs con un *issue* deberán incluir en el título el número del *issue*. E.g. `[#33] Arregla bug` + * Asígnate el PR. + * Cuando el PR esté listo mara ser unido, se deberá solicitar una revisión por parte el equipo de `nostalgic-css/NES.css´. +4. Una vez que el PR sea aprobado, será responsabilidad de la persona **encargada** de unir los cambios a la rama. + +### Formatos de commit + +Utilizamos [Commitizen][commitizen] and [`commitlint`][commitlint] para asegurarnos que nuestros lanzamientos sean automáticos, [unromantic, and unsentimental][sentimental-versioning]. + + + + + +[code-of-conduct]: https://github.com/nostalgic-css/NES.css/blob/master/CODE_OF_CONDUCT.md +[commitizen]: https://github.com/commitizen/cz-cli +[commitlint]: [https://github.com/marionebl/commitlint] +[egghead]: https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github +[new-issue]: https://github.com/nostalgic-css/NES.css/issues/new +[new-pr]: https://github.com/nostalgic-css/NES.css/compare/develop...develop +[semantic-release]: https://github.com/semantic-release/semantic-release +[sentimental-versioning]: http://sentimentalversioning.org/ diff --git a/README-es.md b/README-es.md index 6c73272..6154971 100644 --- a/README-es.md +++ b/README-es.md @@ -1,58 +1,75 @@
- NES.css: NES-style CSS framework + NES.css: NES-style CSS framework English / 日本語 / Español / Português
-NES.css es un Framework CSS **Estilo-NES (8bit)** +NES.css is a **NES-style(8bit-like)** CSS Framework. - -[![Gitter][gitter-badge]][gitter] +[![Gitter][gitter-badge]][gitter] [![Commitizen friendly][commitizen-badge]][commitizen] ## Instalación -### CDN +### Hojas de estilo + +NES.css se encuentra disponible a través de npm (preferente), Yarn o un CDN. + +#### Vía gestor de paquetes + +```shell +npm install nes.css +# o +yarn add nes.css +``` + +Nuestro `package.json` contiene metadata adicional bajo las siguientes keys: +* `sass` - path to our main Sass source file +* `style` - path to our non-minified CSS + +#### Vía CDN + +Importa el CSS utiliando un elemento ``: ```html - + - + ``` -O +### Tipografías -```html - - - - -``` +NES.css no contiene ninguna tipografía, pero recomendamos la siguiente lista de tipografías para utilizar junto a la biblioteca. -### npm - -TODO: npm での使用方法を書く +| Idioma | Tipografía | +|-----------|--------------------------------------------------------------------| +| (Default) | [Press Start 2P](https://fonts.google.com/specimen/Press+Start+2P) | +| Inglés | [Kongtext](https://www.dafont.com/kongtext.font) | +| Japonés | [美咲フォント](http://www.geocities.jp/littlimi/misaki.htm) | +| Japonés | [Nu もち](http://kokagem.sakura.ne.jp/font/mochi/) | ## Uso -NES.css sólo tiene componentes. Tienes que definir tu propio diseño. +NES.css sólo contiene componentes. Tú tienes que definir tu propio diseño. -La tipogfrafía por fefecto es Press Start 2P, la cual tiene soporte para caracteres latinos (acentos, ñ y ü). +La tipografía recomendada para utilizar junto a NES.css es [Press Start 2P][press-start-2p-font]. Sin embargo, [Press Start 2P][press-start-2p-font] sólo soporta caracteres latinos. Si utilizas este framework con otro idioma, por favor utiliza otra tipografía. Sigue las [instrucciones][google-fonts-guide] de Google Fonts acerca de como incluirlas, o simplemente utilizalas como se muestra a continuación: -### Tipografías recomendadas +```html + + + -|Idioma|Tipografía| -|----|----| -|(Default)|[Press Start 2P](https://fonts.google.com/specimen/Press+Start+2P)| -|Latino|[Kongtext](https://www.dafont.com/kongtext.font)| -|Japanese|[美咲フォント](http://www.geocities.jp/littlimi/misaki.htm)| -|Japanese|[Nu もち](http://kokagem.sakura.ne.jp/font/mochi/)| + + +``` +## Sólo CSS -## CSS Only - -NES.css sólo requiere CSS y no depende de JavaScript. - +NES.css sólo requiere de CSS y no depende de JavaScript. ## Soporte de navegadores @@ -64,57 +81,23 @@ NES.css es compatible con las versiones más recientes de los siguientes navegad Sin probar * IE/Edge - -## Desarrollo - -### Comandos -```sh -git clone git@github.com:BcRikko/NES.css.git -cd NES.css - -npm i - -npm run watch -npm run build -``` - -#### Run Storybook -``` -npm run storybook -``` - -Linting, formatting and building se ejecutan automáticamente en el pre-commit hook. -TODO: ビルドはCIでするように変更したい - -### Directorios -```sh -. -├── index.html: Página demo -├── style.css: Estilo de página demo -├── css: Archivos de distribución -├── docs: Storybook stories -└── scss: Código fuente - ├── base - │ ├── reboot.scss: ¡No cambiar! (Bootstrap Reboot) - │ ├── generic.scss: Estilo genérico y reboot.css - │ └── variables.scss: Variables comunes - ├── elements - ├── form - ├── icons: 16x16 iconos - ├── pixel-arts: Para iconos que no son 16x16. - └── utilities -``` - - - ## Derechos de autor y licencia Código y documentación copyright 2018 [B.C.Rikko](https://github.com/BcRikko). Código publicado con Licencia MIT. Documentación publicada con Creative Commons. +## Desarrollo + +Si deseas colaborar con el proyecto ¡Recibimos todo tipo de contribuciones! ¡Revisa nuestro [`CONTRIBUTING-es.md`][contributing-document] para más información acerca de cómo puedes ayudar a hacer NES.css algo grandioso! + +[commitizen]: http://commitizen.github.io/cz-cli/ +[commitizen-badge]: https://img.shields.io/badge/commitizen-friendly-brightgreen.svg +[contributing-document]: https://github.com/nostalgic-css/NES.css/blob/master/CONTRIBUTING-es.md [gitter]: https://gitter.im/nostalgic-css/Lobby [gitter-badge]: https://img.shields.io/gitter/room/nostalgic-css/Lobby.svg +[google-fonts-guide]: https://developers.google.com/fonts/docs/getting_started +[press-start-2p-font]: https://fonts.google.com/specimen/Press+Start+2P?selection.family=Press+Start+2P