Skip to content
This repository has been archived by the owner on Oct 21, 2022. It is now read-only.

For Contributors

Jump to bottom
Gabriel Horner edited this page Oct 19, 2016 · 34 revisions

Intro

See CONTRIBUTING.md.

Answering Issues

Check out new issues that need an answer. Also check out this backlog of older issues that need some love.

When answering an issue:

  • Strive to reproduce errors. If something isn't reproducible, let the user know. Reproducing is often half the battle.
  • If an issue is reproducible, ping @LightTable/committers so we can label it and look into it. You're welcome to look into it as well :)
  • If an issue is resolved, encourage the user to close or ping @LightTable/committers.
  • Be friendly and respectful.
  • For difficult issues, see Debugging Issues. Feel free to add to it as well.
  • Consider updating the FAQ and Developer FAQ. The FAQ is for general user questions and rarely exposes LT's guts. The Developer-FAQ is for questions about LT's guts. The user FAQ page will eventually merge into the offical docs as outlined in this issue.

Issue Labels

All issues should have at least one relevant label. These aid in finding, sorting, and diagnosing issues.

Please keep this list up to date.

  • bug - Use for misc issues that have no distinguishing labels besides being a bug
  • not-reproducible - Add to any issue that doesn't have reproducible steps to fix the issue
  • refactor - Doesn't add or fix any functionality but does improve code quality
  • keybinding - Keybinding issues usually related to Mousetrap or international keyboards
  • nodejs - Should move to Javascript plugin at some point
  • blocked - Blocked by another issue
  • instarepl - Should move to Clojure plugin at some point
  • clojure - Clojure and clojurescript issues that should move to Clojure plugin at some point
  • fixed-upstream - Will be resolved once dependency is updated.
  • enhancement - Interesting feature suggestion which isn't on the roadmap but welcome
  • feature - Feature work that will eventually land in a milestone
  • task - A non-coding chore
  • beginner - Issues that are well suited for contributors new to cljs and/or LT. These issues should should suggest possible solutions with code links to make contributing approachable for a beginner
  • UI (functionality) - Visual issues - usually css
  • plugin (functionality)
  • experience - "paper cut" issues which typically aren't serious but can be frustrating
  • crash - crash-inducing bugs
  • python (language) - Should move to Pythong plugin at some point
  • codemirror (dependency) - code-mirror
  • fixed-on-master - For issues that have been fixed and will be closed once a release happens
  • linux (platform)
  • mac (platform)
  • windows (platform)
  • triaged - stale issues that were closed due to staleness
  • shell - Shell invocation related issues e.g. PATH issues or certain characters in .profile or .bashrc

Maintainers of external Light Table resources

Departing Maintainer's List

Handy list for when you decide you need a break or wish to pursue other paths that do not involve Light Table:

  • Let other organization members know... preferably in advance.
  • Wrap up any outstanding pull requests you opened or hand them off to someone else.
  • Make sure another member has access to any external project resources you controlled.
  • Expect to possibly lose organization access and control - this is a security measure and nothing personal.
  • Don't feel guilt or regret about your decision - relish the experiences gained. You can always come back later!
Clone this wiki locally