diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1f9a83d9fe..d2462e9297 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -8,6 +8,8 @@ For both scenarios the setup is the same, however, the contribution steps differ ## I've Never Contributed to Open Source +![decorative banner image for TwilioQuest mission](./docs/twilio-quest-oss-banner.png) + Contributing to open source can be intimidating at first. For that reason we created a new mission inside [TwilioQuest](https://www.twilio.com/quest) that will guide you step-by-step through creating a contribution for this project. Once you [downloaded the game](https://www.twilio.com/quest/download) you'll be able to select the mission and @@ -29,7 +31,9 @@ Enjoy your quest! ```bash git clone https://github.com//open-pixel-art.git ``` + If you've set up this device with SSH, you can do this instead: + ```bash git clone git@github.com:/open-pixel-art.git ``` @@ -160,11 +164,13 @@ Once you open a pull request, make sure to uncomment the additional info section Please do not open pull requests for inconsequential grammatical changes in the README or other documentation. These types of contributions aren't in the spirit of Hacktoberfest and won't be accepted. Examples of unwanted contributions include but are not limited to: + - adding unnecessary commas, hyphens, or exclamation points - rewording sentences that are already clear enough - changing spelling from American English to British English These kinds of documentation contributions are welcome and appreciated: + - adding translations into new languages - Fixing broken links - Fixing broken markdown formatting diff --git a/README.md b/README.md index f0f6aee163..c68d11dbf6 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,7 @@ Visit [open-pixel-art.com](https://open-pixel-art.com) to see the full artwork! Anyone who wishes to learn how to create a pull request for a project on GitHub can use this project to contribute a pixel to the canvas. You will only be able to ever create one pixel but you can pick whatever color you prefer as long as it is a valid HEX code. For example: `#F22F46` the brand color of [Twilio](https://www.twilio.com) +> ![decorative banner image for TwilioQuest mission](./docs/twilio-quest-oss-banner.png) > If you are new to open-source, GitHub or git in general, fear not, we created a tutorial in [TwilioQuest](https://twil.io/hacktoberfest-quest) for you. It will teach you step by step on how you can get started and will guide you on your quest of creating your pull request. > 🕹 [Download TwilioQuest](https://www.twilio.com/quest/download) diff --git a/docs/br/CONTRIBUTING.md b/docs/br/CONTRIBUTING.md index de2fb63df0..581f14e51c 100644 --- a/docs/br/CONTRIBUTING.md +++ b/docs/br/CONTRIBUTING.md @@ -8,7 +8,9 @@ Nos dois cenários, a configuração é a mesma, no entanto, as etapas de contri ## Nunca contribuí com código aberto -Contribuir para o código aberto pode ser intimidador a princípio. Por esse motivo, criamos uma missão dentro do [TwilioQuest](https://www.twilio.com/quest) que o guiará passo a passo na criação de uma contribuição para este projeto. [Depois de baixar o jogo](https://www.twilio.com/quest/download), você poderá selecionar a missão e ela o guiará por todas as etapas, desde a clonagem do projeto até a criação da sua pull request. +![decorative banner image for TwilioQuest mission](../twilio-quest-oss-banner.png) + +Contribuir para o código aberto pode ser intimidador a princípio. Por esse motivo, criamos uma missão dentro do [TwilioQuest](https://twil.io/hacktoberfest-quest) que o guiará passo a passo na criação de uma contribuição para este projeto. [Depois de baixar o jogo](https://www.twilio.com/quest/download), você poderá selecionar a missão e ela o guiará por todas as etapas, desde a clonagem do projeto até a criação da sua pull request. Aproveite sua busca! diff --git a/docs/br/README.md b/docs/br/README.md index bd10962d24..d6ff419d1c 100644 --- a/docs/br/README.md +++ b/docs/br/README.md @@ -2,41 +2,42 @@ [![All Contributors](https://img.shields.io/badge/all_contributors-12-orange.svg?style=flat-square)](#contributors) [![A Twilio Labs Project](https://img.shields.io/static/v1?label=&message=Twilio-Labs&color=F22F46&labelColor=0D122B&logo=twilio&style=flat-square)](https://www.twilio.com/labs) [![Netlify Status](https://api.netlify.com/api/v1/badges/611ac0f9-4ae9-48a2-9769-26c32cb5f9e8/deploy-status)](https://app.netlify.com/sites/pixel-project-dev/deploys) -Este é um projeto de arte criado com a intenção de ensiná-lo a criar uma pull +Este é um projeto de arte criado com a intenção de ensiná-lo a criar uma pull request. -Visite [open-pixel-art.com](https://open-pixel-art.com) para ver a obra de arte +Visite [open-pixel-art.com](https://open-pixel-art.com) para ver a obra de arte completa! -Qualquer pessoa que deseje aprender como criar uma pull request para um projeto -no GitHub pode usar esse projeto para contribuir com um pixel na tela. Você só -poderá criar um pixel, mas poderá escolher a cor que preferir, desde que seja um +Qualquer pessoa que deseje aprender como criar uma pull request para um projeto +no GitHub pode usar esse projeto para contribuir com um pixel na tela. Você só +poderá criar um pixel, mas poderá escolher a cor que preferir, desde que seja um código HEX válido. Por exemplo: `#F22F46` a cor da marca de [Twilio](https://www.twilio.com) -> Se você é novo no código-fonte aberto, no GitHub ou no git em geral, não tenha -medo, criamos um tutorial em [TwilioQuest](https://www.twilio.com/quest) para -você. Ele ensinará passo a passo sobre como você pode começar e o guiará na sua -busca de criar sua solicitação de recebimento. +> ![decorative banner image for TwilioQuest mission](../twilio-quest-oss-banner.png) +> Se você é novo no código-fonte aberto, no GitHub ou no git em geral, não tenha +> medo, criamos um tutorial em [TwilioQuest](https://www.twilio.com/quest) para +> você. Ele ensinará passo a passo sobre como você pode começar e o guiará na sua +> busca de criar sua solicitação de recebimento. > 🕹 [Download TwilioQuest](https://www.twilio.com/quest/download) -Todo o projeto é automatizado e é amplamente mantido por um conjunto de bots que -verificará qualquer contribuição de pixel. No entanto, se você quiser saber mais -sobre o projeto ou enviar outras contribuições ao projeto que não sejam um pixel, -sinta-se à vontade para criar um [problema no GitHub](https://github.com/twilio-labs/open-pixel-art/issues) +Todo o projeto é automatizado e é amplamente mantido por um conjunto de bots que +verificará qualquer contribuição de pixel. No entanto, se você quiser saber mais +sobre o projeto ou enviar outras contribuições ao projeto que não sejam um pixel, +sinta-se à vontade para criar um [problema no GitHub](https://github.com/twilio-labs/open-pixel-art/issues) dentro do [Open Pixel Art project](https://github.com/twilio-labs/open-pixel-art). ## Contribuindo -Para contribuir com um pixel na tela, você deverá criar uma [pull request](https://opensource.guide/how-to-contribute/#opening-a-pull-request) +Para contribuir com um pixel na tela, você deverá criar uma [pull request](https://opensource.guide/how-to-contribute/#opening-a-pull-request) para o [Open Pixel Art project on GitHub](https://github.com/twilio-labs/open-pixel-art). -Se você já conhece o git e como criar uma solicitação pull no GitHub, pode seguir +Se você já conhece o git e como criar uma solicitação pull no GitHub, pode seguir em frente e conferir o [guia de contribuição](CONTRIBUTING.md). -Entendemos que contribuir com o código aberto pode ser intimidador e, como -resultado, criamos uma missão em nosso jogo de codificação interativo -[TwilioQuest](https://www.twilio.com/quest) que o orientará passo a passo na -criação de um puxe a solicitação para este projeto e ajude você a embarcar em +Entendemos que contribuir com o código aberto pode ser intimidador e, como +resultado, criamos uma missão em nosso jogo de codificação interativo +[TwilioQuest](https://www.twilio.com/quest) que o orientará passo a passo na +criação de um puxe a solicitação para este projeto e ajude você a embarcar em sua nova busca no código-fonte aberto! - [Download TwilioQuest](https://www.twilio.com/quest/download) @@ -48,8 +49,8 @@ sua nova busca no código-fonte aberto! ## Código de conduta -Queremos garantir que este projeto seja o mais acolhedor possível. Ao interagir -com o projeto de qualquer forma ou formato, você concorda com o Código de +Queremos garantir que este projeto seja o mais acolhedor possível. Ao interagir +com o projeto de qualquer forma ou formato, você concorda com o Código de Conduta do projeto: - [Inglês](CODE_OF_CONDUCT.md) @@ -86,7 +87,7 @@ Obrigado vai a essas pessoas maravilhosas ([emoji key](https://allcontributors.o -Este projeto segue a especificação [todos os colaboradores](https://github.com/all-contributors/all-contributors). +Este projeto segue a especificação [todos os colaboradores](https://github.com/all-contributors/all-contributors). Contribuições de qualquer tipo são bem-vindas! ## Agradecimentos diff --git a/docs/de/CONTRIBUTING.md b/docs/de/CONTRIBUTING.md index 33053aede2..05f766cc8d 100644 --- a/docs/de/CONTRIBUTING.md +++ b/docs/de/CONTRIBUTING.md @@ -6,8 +6,10 @@ Für beide Szenarien ist der Aufbau gleich, jedoch unterscheiden sich die Beitra ## Ich habe noch nie zu Open Source beigetragen +![decorative banner image for TwilioQuest mission](../twilio-quest-oss-banner.png) + Einen Beitrag zu Open Source zu leisten, kann zunächst einschüchternd sein. Aus diesem Grund haben wir eine -Neue Mission in [TwilioQuest](https://www.twilio.com/quest), die dich +Neue Mission in [TwilioQuest](https://twil.io/hacktoberfest-quest), die dich Schritt für Schritt durch das Erstellen eines Beitrags für dieses Projekt führt. Sobald Du [das Spiel heruntergeladen](https://www.twilio.com/quest/download) hast, kannst Du die Mission auswählen und Du wirst durch alle Schritte durchgeführt, vom Klonen des Projekts bis zur Erstellung deines Pull-Requests. Viel Spaß beim Quest! diff --git a/docs/de/README.md b/docs/de/README.md index 4258804484..52fff36014 100644 --- a/docs/de/README.md +++ b/docs/de/README.md @@ -1,4 +1,4 @@ -# Open Pixel Art von [Twilio](https://www.twilio.com) +# Open Pixel Art von [Twilio](https://www.twilio.com) [![Alle Mitwirkenden](https://img.shields.io/badge/all_contributors-12-orange.svg?style=flat-square)](#mitwirkende) [![Ein Twilio Labs-Projekt](https://img.shields.io/static/v1?label=&message=Twilio-Labs&color=F22F46&labelColor=0D122B&logo=twilio&style=flat-square)](https://www.twilio.com/labs) [![Netlify Status](https://api.netlify.com/api/v1/badges/611ac0f9-4ae9-48a2-9769-26c32cb5f9e8/deploy-status)](https://app.netlify.com/sites/pixel-project-dev/deploys) @@ -8,6 +8,7 @@ Besuchen Sie [open-pixel-art.com](https://open-pixel-art.com), um das vollständ Jeder, der lernen möchte, wie man eine Pull-Anfrage für ein Projekt auf GitHub erstellt, kann dieses Projekt verwenden, um einen Pixel auf die Leinwand zu bringen. Sie können immer nur ein Pixel erstellen, aber Sie können jede gewünschte Farbe pixen, solange es sich um einen gültigen HEX-Code handelt. Zum Beispiel: `#F22F46` die Markenfarbe von [Twilio](https://www.twilio.com) +> ![decorative banner image for TwilioQuest mission](../twilio-quest-oss-banner.png) > Wenn Sie neu in Open Source, GitHub oder Git im Allgemeinen sind, haben wir in [TwilioQuest](https://www.twilio.com/quest) ein Tutorial für Sie erstellt. Hier erfahren Sie Schritt für Schritt, wie Sie beginnen können, und werden bei der Erstellung Ihrer Pull-Anfrage unterstützt. > 🕹 [TwilioQuest herunterladen](https://www.twilio.com/quest/download) @@ -23,9 +24,9 @@ In unserem interaktiven Codierungsspiel [TwilioQuest](https://www.twilio.com/que - [TwilioQuest herunterladen](https://www.twilio.com/quest/download) - Schauen Sie sich die Contribution Guides an: - - [Englisch](CONTRIBUTING.md) - - [Español](docs/es/CONTRIBUTING.md) - - [Deutsch](docs/de/CONTRIBUTING.md) + - [Englisch](CONTRIBUTING.md) + - [Español](docs/es/CONTRIBUTING.md) + - [Deutsch](docs/de/CONTRIBUTING.md) ## Verhaltensregeln diff --git a/docs/es/CONTRIBUTING.md b/docs/es/CONTRIBUTING.md index acc46ac6db..29ac02c61e 100644 --- a/docs/es/CONTRIBUTING.md +++ b/docs/es/CONTRIBUTING.md @@ -6,7 +6,9 @@ Para ambos escenarios la configuración es la misma, pero los pasos para contrib ## Si nunca has contribuido a código abierto -Contribuir a código abierto puede ser intimidante. Por esa misma razón, creamos una misión nueva en [TwilioQuest](https://www.twilio.com/quest) que te guiará +![decorative banner image for TwilioQuest mission](../twilio-quest-oss-banner.png) + +Contribuir a código abierto puede ser intimidante. Por esa misma razón, creamos una misión nueva en [TwilioQuest](https://twil.io/hacktoberfest-quest) que te guiará paso a paso para crear una contribución a este proyecto. Después de [descargar el juego](https://www.twilio.com/quest/download), podrás elegir la misión y ésta te guiará a través de todos los pasos necesarios, desde clonar el proyecto hasta crear tu pull request. diff --git a/docs/es/README.md b/docs/es/README.md index 0ae1f08516..54d3587b13 100644 --- a/docs/es/README.md +++ b/docs/es/README.md @@ -8,6 +8,7 @@ Este es un proyecto artístico creado con la intención de enseñarte cómo crea Quienes quieran aprender cómo crear un pull request en GitHub pueden usar este proyecto para contribuir con un pixel y agregarlo al canvas. Solo podrás crear un pixel, pero puedes elegir el color que quieras, siempre y cuando sea un color válido en formato hexadecimal. Por ejemplo, puedes usar: `#F22F46`, uno de los colores oficiales de [Twilio](https://www.twilio.com) +> ![decorative banner image for TwilioQuest mission](../twilio-quest-oss-banner.png) > Si no tienes experiencia con código abierto, GitHub o usando git, ¡no hay problema!. Creamos un tutorial en [TwilioQuest](https://www.twilio.com/quest) especialmente para ti. Este tutorial te enseñará paso a paso como partir y te guiará en esta aventura de crear un pull request. > 🕹 [Descarga TwilioQuest](https://www.twilio.com/quest/download) @@ -24,7 +25,7 @@ Y como sabemos que contribuir a código abierto puede ser intimidante, también - [Descarga TwilioQuest](https://www.twilio.com/quest/download) - Revisa nuestras guías de contribución: - [Español](CONTRIBUTING.md) - - [Inglés](https://github.com/twilio-labs/open-pixel-art/blob/master/CONTRIBUTING.md) + - [Inglés](https://github.com/twilio-labs/open-pixel-art/blob/master/CONTRIBUTING.md) ## Código de Conducta diff --git a/docs/twilio-quest-oss-banner.png b/docs/twilio-quest-oss-banner.png new file mode 100644 index 0000000000..a8da4805b2 Binary files /dev/null and b/docs/twilio-quest-oss-banner.png differ diff --git a/docs/zh/CONTRIBUTING.md b/docs/zh/CONTRIBUTING.md index b6a5dd93c9..b27fddf09a 100644 --- a/docs/zh/CONTRIBUTING.md +++ b/docs/zh/CONTRIBUTING.md @@ -8,7 +8,9 @@ ## 这是我第一次为开源项目贡献代码 -为了使你第一次为开源项目贡献代码更顺利，我们在[TwilioQuest](https://www.twilio.com/quest)里增加了一个“手把手为这个项目贡献代码”的教程任务。只需[下载这个游戏](https://www.twilio.com/quest/download)即可选择此任务，教程涵盖从克隆项目（cloning）到提交代码（pull request）的每一步骤。 +![decorative banner image for TwilioQuest mission](../twilio-quest-oss-banner.png) + +为了使你第一次为开源项目贡献代码更顺利，我们在[TwilioQuest](https://twil.io/hacktoberfest-quest)里增加了一个“手把手为这个项目贡献代码”的教程任务。只需[下载这个游戏](https://www.twilio.com/quest/download)即可选择此任务，教程涵盖从克隆项目（cloning）到提交代码（pull request）的每一步骤。 祝你开源项目探险愉快！