matryer / matryer/xbar-plugins

Node script with dependencies

Open
#1,118 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

node php question
Dominant language
Shell
Stars
2.6k
Forks
1.1k
Avg merge
9d 15h
Merged PRs (30d)
1

Description

I've written [a BitBar plugin in JavaScript](https://github.com/colbin8r/bitbar-docker-ps). My script has a few dependencies (including the suggested [bitbar](https://github.com/sindresorhus/bitbar) package) and so I'm not sure how to contribute it to the plugins repo.

In [my readme](https://github.com/colbin8r/bitbar-docker-ps#installation), I suggest cloning the repo into the plugins folder, installing the dependencies (`npm install`), and then symlinking the script into the plugins folder. It works great, but I'd like to contribute it to the folder to help make it easier for others to find.

Seeing as I can only contribute a single script file without dependencies, what's the best way to submit the plugin to this repo?

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the linked bitbar-docker-ps repository and its README installation section, then inspect this repository's plugin folder and contribution expectations. Determine whether a JavaScript plugin with npm dependencies can be represented here; done means a documented, accepted contribution path is clear.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, node.js
Domain
tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.