Skip to content

Latest commit

 

History

History
83 lines (50 loc) · 4.23 KB

CONTRIBUTING.md

File metadata and controls

83 lines (50 loc) · 4.23 KB
Raw

image

🎉🎊 Firstly ,thanks for taking the time to contribute 🎉🎊

What should I know before I get started?

Code of Conduct

By participating, you are expected to uphold this code of conduct. Keep the peace and Please report unacceptable behavior to toronto324@gmail.com.

What is TwilioQuest?

TwilioQuest is an educational video game designed to teach a new generation of developers how to change the world with code. TwilioQuest prepares you for real-world programming by helping you configure a local development environment and introducing tools used by professional programmers around the world.

Download and learn more about TwilioQuest here

TwilioQuest Extentions

TwilioQuest Extensions allow you to build educational RPG adventures for players to enjoy in TwilioQuest. You can create new levels , design your own maps and author learning objective content for players to complete in-game. You can teach players a programming languag or how to use some dev tools, etc.. It's up to you to think about what you might want to create, exciting right?

Take a look at the docs for a guide on how to get started and for the API Reference

How can i contribute? 👥

Reporting Bugs 🐞

Before creating bug reports, please check here to see if one has not already been created. When you are creating a bug report, please include as many details as possible and fill out the template to the best of your ability. This helps us understand and resolve issues faster.

Suggesting new Feautures\Enhancements ✨

Have an idea for a new feature or an enhancement? We're all ears 👀👂🏾.

Fill out the template and try to include as many details as possible including the steps that you imagine you would take if the feature you're requesting existed.

a few things to keep in mind

  • Could this feature be implemented with the TwilioQuest Extention API ?
  • How will this feature be useful to players ?

Picking up a TODO Item ✅

Not reporting a bug or suggesting a feature but still looking to contribute? Check out the project section of this repository, in there you will find a To-do column for everyone with cards that are planned but not currently being worked on. If you'd like to work on a card follow these steps :

  • Simply create an issue with the to do label
  • Indicate that you'd like to work on ____.
  • Include a link to the card
  • Assign this issue to yourself
  • When creating a PR be sure to link this issue.

First timers 💌

First time?

You can start by looking through issues labeled good first issue or up-for-grabs and the like... Also you may want to be familiarize yourself with the way extentions for TwilioQuest architecture. Feel free to ask questions in the discusstions about this extention. Additionally take a look at the projects tab for an idea on whats being worked on now or what is being planned in the future for each level.

An easy way to contribute is to test the extention inside twilioquest and report any bugs while playing through the levels in the extension -- Even better if you're comfortable with assigning the bug to yourself to work on!

.. So have fun and jump in!

Local Development 💻

  • Fork this repository & clone it.
  • Create a branch off main and give it relavent name
  • Follow the directions in the first section here to enable the extention in TwilioQuest
  • run npm install

It's recommended that you keep your branch up to date with this repository's main branch

Submitting a Pull Request 📤

Please follow these steps to have your contribution considered:

  • Fill out the PR template
  • Assign a reviewer
  • Resolve any conversations or changes requested