Find file
cb2f28c Jun 24, 2015
@lindaliukas @RichardLitt @hone
90 lines (56 sloc) 3.32 KB


This is the of our project. Great to have you here. Here are a few ways you can help make this project better!

Team members

This section introduces the core team members.

Learn & listen

This section includes ways to get started with your open source project. Include links to documentation and to different communication channels:

  • Mailing list:
  • IRC channel:
  • Blog:
  • Anything else:

Adding new features

This section includes advice on how to build new features for the project & what kind of process it includes.

  • This is how we like people to add new features:
  • Here are some specifics on the coding style we prefer:
  • This is how you send your pull request:
  • You should include the following tests:
  • These are the updates we hope you make to the changelog:

Don’t get discouraged! We estimate that the response time from the maintainers is around:

Bug triage

This sections explains how bug triaging is done for your project. Help beginners by including examples to good bug reports and providing them questions they should look to answer.

  • You can help report bugs by filing them here:
  • You can look through the existing bugs here:

  • You can help us diagnose and fix existing bugs by asking and providing answers for the following:

    • Is the bug reproducible as explained?
    • Is it reproducible in other environments (for instance, on different browsers or devices)?
    • Are the steps to reproduce the bug clear? If not, can you describe how you might reproduce it?
    • What tags should the bug have?
    • Is this bug something you have run into? Would you appreciate it being looked into faster?
  • You can close fixed bugs by testing old tickets to see if they are still happening.

  • You can update our changelog here:
  • You can remove duplicate bug reports by:

Beta testing

This section explains if your project needs beta testing. Explain why early releases require heavy testing and how they can help with specially across browsers and on different hardware.

  • For our project you can find the roadmap and features that require testing from here:


This section includes any instructions or translation needs your project has.

  • You can help us translate our project here:


This section includes any help you need with the documentation and where it can be found. Code needs explanation, and sometimes those who know the code well have trouble explaining it to someone just getting into it.

  • Help us with documentation here


This section includes ideas on how non-developers can help with the project. Here's a few examples:

  • You can help us answer questions our users have here:
  • You can help build and design our website here:
  • You can help write blog posts about the project by:
  • You can help with newsletters and internal communications by:

  • Create an example of the project in real world by building something or showing what others have built.

  • Write about other people’s projects based on this project. Show how it’s used in daily life. Take screenshots and make videos!

Your first bugfix

This section should help a person get started with their very first bug fix and thinking through the problem.

  • If you have further questions, contact: