Skip to content

Contributor Guidelines

Jump to bottom
William O'Beirne edited this page Dec 12, 2018 · 1 revision

Thanks for showing interest in contributing to Joule! Here are some basic guides for how to best help out, depending on how you're looking to contribute.

If your contribution doesn't fit in to those, feel free to hit me up on Twitter @wbobeirne.

Reporting a Bug

If you've found a bug, or something confusing about MyCrypto, here's what you should do:

  1. Search for your issue - If you're experiencing something, the chances are good that someone else is too. Search the issue queue before posting. You may even find an answer to your problem!
  2. Describe the issue in detail - Instead of describing something as "not working" or being "broken", explain what you expected to happen, and what's happening instead, or just not happening.
  3. Provide console logs - Every browser has the ability to view logs from Javascript, which is where many error messages will get displayed if there's a bug in the code. Here's how in Firefox, Chrome, Internet Explorer, Microsoft Edge, and Safari. You'll want to provide us with as many of the logs as possible, especially anything in red.
  4. Provide browser information - Let us know what operating system, browser, browser version, and node software you're using. This will help with debugging your issue on a similar setup.

Following the above steps will ensure that your bug is addressed in a timely and efficient manner. Thanks for keeping Joule bug free!

Feature Request

If there's a feature that you think would make Joule a better product, we want to know. Here's the best way to do it:

  • Search for your suggestion - If you've thought of a good new feature, chances are someone else may have too. To consolidate issues, we'll keep feature requests in one thread. Show your support for a request by using the thumbs up response on the Github issue.
  • Describe your suggestion - Describe, in detail, how you would want this new feature to work. If something doesn't work very well, it helps to know the pain points. If you have an idea of how to make it better, feel free to suggest!
  • Provide examples - If it's something another website or app is doing, shoot us a link or a screenshot. We build better projects by working with other developers in our community. Features that are requested with the above information have a better chance of getting implemented. Thanks for the suggestions!

Features that are requested with the above information have a better chance of getting implemented. Thanks for the suggestions!

Contributing Code

So you want to contribute code? Awesome! Depending on how much experience you have with the tech here, you might want to brush up on some things first.

Read the README

It's over here: https://github.com/wbobeirne/joule-extension. It covers basics on what tech and libraries the project uses, how to get started,

Learn Lightning

Learn more about lightning over at https://dev.lightning.community/guides/index.html. A strong foundational understanding of how Lightning and Bitcoin works is important for contributors, both from a technical standpoint, but also in understanding the UX and ethos of Joule.

Learn the Stack

You'll want to be at least familiar with:

If any of this stuff is hard to grok, hop in the LND Developer Slack and hit me up with questions. I look forward to your contributions!

Make sure there's an issue

Even the best developer might submit a pull request that doesn't get accepted if they didn't discuss what they were doing in an issue first. Drop an issue for the bug or feature you're building for, and make sure it's in the best interests of the project before spending too much time on it. Pull requests with issues associated with them have a much higher chance of acceptance.

Partnership

If you'd like to partner on something, please reach out to me on Twitter, or in the LND Developer Slack. We can go from there!

Clone this wiki locally