rhymus

Rime

Un projet de jeu de rimes open source conçu pour les nouveaux développeurs et les nouveaux contributeurs.

Nouvelles

Au 22 janvier, la branche master-vue est maintenant en place et prête pour les contributions! Vous pouvez utiliser la branche master existante comme modèle pour la façon dont l'application VUE doit être développée. Les tests unitaires (en utilisant JEST) et VUEX (pour la gestion de l'État) sont inclus dans le projet VUE.

Des améliorations supplémentaires à la branche Vanilla master sont toujours les bienvenues. React aura sa propre succursale mis en place quelque temps en février.

En tant que développeur VUE professionnel, je serai particulièrement impliqué dans les contributions et toutes les questions concernant la branche master-vue , alors n'hésitez pas à demander des conseils et à faire ces RP!

Gameplay

Rhymus est un jeu open-source qui affichera des cartes avec des phrases dessus. Chaque phrase aura un mot qui n'a pas tout à fait de sens mais rime avec un mot qui le fait. Par exemple, «j'ai un brouillard pour animaux de compagnie». -> Réponse: «chien». Une minuterie vous donne 30 secondes pour en terminer autant que possible.

Conception

Ce projet passera par deux phases . Le premier sera une version initiale à l'aide d'un back-end de nœud et de HTML, CSS et JS frontal. Pour la première version, il n'y aura pas d'implémentation React / Redux.

Une fois la première version complète et complète des fonctionnalités, deux nouvelles branches seront créées dans lesquelles le projet sera refactorisé à l'aide de React et Vue .

Contributions

Ce projet part de zéro, il existe donc de nombreuses opportunités de contribuer. Le moyen le plus rapide de contribuer est de consulter l'onglet Projets et de voir quelles priorités sont là . Sinon, l'un des éléments suivants est un excellent moyen de contribuer:

• Édition de la lecture
• Création de nouveaux fichiers pour la structure du projet
• Restructurer le projet pour se conformer aux meilleures pratiques
• Codage de l'un des frontaux ou du back-end
• Codage de fichiers de test
• Offrant un style alternatif
• Suggérant de meilleures pratiques pour la gestion de GitHub (y compris les directives de contribution)

Lignes directrices de contribution

Lorsque vous contribuez, veuillez utiliser les directives suivantes:

• Nommez votre succursale d'une manière qui reflète ce que vous prévoyez de faire («Implexe-Card-Scrolling»)
• Fournir des informations détaillées dans votre demande de traction concernant ce que vous avez fait et pourquoi cela se fait de cette façon
• Dans votre demande de traction, réfléchissez à votre code et incluez des commentaires pour savoir s'il peut avoir besoin de refactorisation ou si quelque chose était particulièrement difficile
• Inclure des tests avec votre contribution le cas échéant

Il s'agit d'un projet open source pour les développeurs de tous les niveaux d'expérience. Veuillez montrer la courtoisie commune et fournir des commentaires constructifs dans la mesure du possible.

Guide complet pour les débutants

Si vous êtes entièrement nouveau à contribuer à des projets open source ou à utiliser GIT, suivez ce petit guide pour créer votre premier PR. Gardez à l'esprit qu'il existe de nombreuses façons de terminer cela, mais cela est conçu pour être très basique et facile à suivre. Si ce n'est pas le cas, veuillez le corriger!

1. Cliquez sur Fork en haut à droite pour faire une copie de ce référentiel.
2. En supposant que Gitbash soit installé, cliquez avec le bouton droit sur le dossier de vos documents (où vous stockez des dossiers de projet) et ouvrez à Gitbash.
3. Tapez git clone https://[email protected]/username/rhymus .
4. Ouvrez ce dossier dans votre IDE (tel que Visual Studio Code).
5. Dans votre terminal (ouvert à partir du borne déroulant en haut dans le code VS), tapez git checkout -b add-puzzle .
6. À gauche, ouvrez le dossier SRC puis le dossier JS et ouvrez Puzzles.js .
7. Suivez le modèle que vous voyez là-bas et créez un nouveau puzzle de rimes et enregistrez vos modifications.
8. Dans votre terminal, tapez git commit -m "added new puzzle" .
9. Dans votre terminal, tapez git remote add origin https://[email protected]/username/rhymus .
10. Dans votre terminal, tapez git push origin add-puzzle .
11. Dans GitHub, accédez à votre référentiel et sélectionnez la branche add-puzzle .
12. Cliquez sur le nouveau bouton Pull Demande et remplissez-le.

Fait!

Mais attendez, qu'est-ce qui vient de se passer?

1. FORKING a créé une copie du référentiel sous votre compte GitHub. 2 - 3) En utilisant Gitbash, vous mettez une copie de ce référentiel sur votre machine locale où vous pouvez ouvrir et modifier tous les fichiers. Le clonage fait juste une copie exacte du référentiel à laquelle l'URL pointe. 4 - 5) Vous avez ouvert le dossier et créé une nouvelle branche. Le paiement se déplace vers une nouvelle branche, et le -b signifie qu'il créera la nouvelle branche. 6 - 7) Vous avez ajouté un nouveau puzzle suivant le modèle, espérons-le!
2. Vous avez commis votre sauvegarde! Cela signifie que vous avez officiellement sauvé et que vous avez préparé vos modifications à être poussée officiellement à votre référentiel. Le -m signifie un message joint à l'engagement afin que vous et d'autres puissent voir de quoi il s'agit.
3. Vous avez ajouté une télécommande! C'est un endroit où vous allez pousser régulièrement. Vous ne ajouterez qu'une seule télécommande une seule fois, puis vous lui donnez un surnom (généralement d'origine) que vous pouvez utiliser au lieu de taper l'URL longue à chaque fois.
4. Vous avez poussé de votre sauvegarde locale dans votre référentiel sur la branche Add-Puzzle! Votre engagement est officiellement dans votre référentiel en ligne! 11 - 12) Vous avez fait une demande de traction, qui est une demande de référentiel d'origine (celui-ci) pour accepter vos modifications dans la base!

Peut-être que vous pensez: "Attendez, et si mon code est terrible? Ou cassé? Ou complètement mal?" Peu importe! Lorsque vous effectuez une demande de traction, votre code sera examiné avant d'être fusionné dans le référentiel officiel. S'il a besoin de modifications, vous recevrez des commentaires expliquant quoi, comment et pourquoi changer! Une fois que vous avez apporté des modifications, vous pouvez repousser et il mettra automatiquement à jour votre demande de traction (alors ne le fermez pas s'il n'est pas approuvé tout de suite). Faire ces erreurs est exactement la façon dont vous apprendrez.

Si vous vous sentez audacieux, faites plus de modifications, de commits, de poussées et de relations publiques!

À propos de l'auteur

Je suis un développeur de logiciels complet travaillant actuellement à Tokyo, au Japon. J'ai assemblé ce projet pour solidifier et partager mes connaissances de la programmation. J'offre également des programmes de méthorship aux programmeurs en herbe dans des blocs de trois mois, alors n'hésitez pas à me consulter sur LinkedIn et à me contacter si vous êtes intéressé à trouver un mentor.