Skip to content

Latest commit

 

History

History
48 lines (36 loc) · 2.82 KB

GETTING_STARTED.md

File metadata and controls

48 lines (36 loc) · 2.82 KB
Raw

Kazoo Community Getting Started Guide

Who Can Contribute?

Everyone can!

Do I have to know Erlang?

Of course not! We have many different places where folks can chip in time. These include (but aren't limited to):

  • Maintaining and expanding the wiki
  • Blogging, tweeting, and other forms of publicizing your usage of and love for the platform, code, company, community, etc.
  • Join us in real time and help other community members:
  • Contribute scripts to the community repo
  • Help with building RPMs, DEBs, and other system packages
  • Help with Chef, bluepill, and other OPS-related tasks
  • Browse the open Issues and test bugs to see if they're valid

I know other languages! Can I still help code?

Programming-related help

  • Check out our GUI and write some Javascript.
  • Check out our REST APIs and write SDKs in your favorite languages
  • Check out our Pivot APIs and write SDKs in your favorite languages
  • Check out our AMQP APIs and write your own whapps on your Kazoo install
  • Write some automated testing tools for testing the APIs
  • Write some SIPp test scripts to test the full stack

Non-English Language help

Translation efforts are always appreciated. We're working on redesigning how our back- and front-ends handle the world's languages and hope to make it easy to contribute translations. Stay tuned for more; please let us know of your interest and be sure to join the mailing lists so you can receive announcements regarding internationalization efforts.

I know (or am learning) Erlang! How do I help with Kazoo?

  • Clone the repo
  • Squash a bug, build a feature, etc
    • Browse the ticket queue and find one you'd like to tackle.
    • Feel free to drop a line to the dev mailing list letting us know you're taking on a ticket, especially if you have questions.
  • Once you feel the code is ready for inclusion, issue a pull request
    • Please keep your pull requests focused and specific to the task at hand
    • If, in the course of your work you add/modify/delete code unrelated to the core task, create a new ticket describing why you've made these additional changes, and issue a separate pull request.