Skip to content

Latest commit

 

History

History
71 lines (51 loc) · 2.66 KB

CONTRIBUTING.md

File metadata and controls

71 lines (51 loc) · 2.66 KB
Raw

Contributing to Oboe.js

👍🎉 First off, thanks for taking the time to contribute! 🎉👍

The following is a set of guidelines for contributing to Oboe.js. These are just guidelines, not rules, use your best judgment and feel free to propose changes to this document in a pull request.

Read the docs :)

Oboe.js has some awesome documentation explaining how and why to use the library.

Questions/Help

Sometimes your question can be addressed by reading the API closely. It's short and nicely organized!

Please post questions to StackOverflow using the oboe.js andjavascript tags.

If you file an issue with an implementation question, it will be closed. We're not trying to be mean, it just helps keep the issues tab cleaner so we can keep improving the library.

Reporting Bugs / Requesting Features

If you've found an issue, please submit it in the issues.

To increase our ability to help, please:

  • If it's a server-side bug, fork our bug-template, recreate your bug, and then provide a link to that repo.
  • If it's a client-side template, provide a link to a jsbin/codepen/plunkr that demonstrates the issue (if it's on the client), or a github repo (if it's on the server), greatly increases our ability to help.

Pull Requests

If you would like to add functionality, please submit an issue first to make sure it's a direction we want to take.

Please do the following:

  • Follow the existing styles
  • Create an example for that demonstrates your changes so people can see how your changes work

In your PR description include any information that will help a maintainer understand and test your changes. The easier it is to read and run your PR, the faster it can get merged!

What does Oboe need help with?

Helping others!

There is a Google Group for general project discussion. If you have a moment to help other people using the library, please stop in.

Contributing to community

  • Write examples! The website has a section showing common use-cases, and it could always use some more. Feel free to submit a PR to the website.
  • We would also like to showcase applications using Oboe, so if you've published one and want to share it, file it in the website issues and we'll showcase it!