GithubHelp home page GithubHelp logo

Plugin packaging about oh-my-fish HOT 13 CLOSED

oh-my-fish avatar oh-my-fish commented on May 23, 2024
Plugin packaging

from oh-my-fish.

Comments (13)

rominf avatar rominf commented on May 23, 2024

Of course, README.md should contain only description. I'm against copy-pasing text like:

to install write:
...
to uninstall write:
...

I think that:

For more information on `oh-my-fish` visit ...

would be enough. This text is easy to append automatically by script to all plugins.

from oh-my-fish.

derekstavis avatar derekstavis commented on May 23, 2024

I'd prefer using git tags instead of branches, this way plugins can be versioned using semver.

from oh-my-fish.

derekstavis avatar derekstavis commented on May 23, 2024

But I definitely like omf info command and your proposed output!!

from oh-my-fish.

rominf avatar rominf commented on May 23, 2024

I'd prefer using git tags instead of branches, this way plugins can be versioned using semver.

You are right. I meant tags, not branches. I'll fix it.

from oh-my-fish.

bpinto avatar bpinto commented on May 23, 2024

I believe I didn't understand the proposal for the README file. Could you try explaining again?

from oh-my-fish.

rominf avatar rominf commented on May 23, 2024

@bpinto
Well. Printing markdown to a console output is not a very good idea.

I actually vote for self-documented code, so I think that after implementation of fish-shell/fish-shell#478 we can just simply build README files from the help. So, for now, I would leave README files as they are.

BTW, it's possible to extract repository description from .git/description file.

I've changed proposal again.

from oh-my-fish.

bpinto avatar bpinto commented on May 23, 2024

I can see this working as it was proposed, might be interesting to see what current plugins would output.

from oh-my-fish.

jeremiejig avatar jeremiejig commented on May 23, 2024

See also git describe to generate a version, which relies on annotated tag.

from oh-my-fish.

derekstavis avatar derekstavis commented on May 23, 2024

I usually use git describe --tags --always HEAD

from oh-my-fish.

bpinto avatar bpinto commented on May 23, 2024

@rominf are you working on a PR for this?

from oh-my-fish.

rominf avatar rominf commented on May 23, 2024

@bpinto, no.

from oh-my-fish.

sagebind avatar sagebind commented on May 23, 2024

This will be marked as solved as part of the effort in #427.

from oh-my-fish.

sagebind avatar sagebind commented on May 23, 2024

#427 is merged. Packages can now be grouped, be more discoverable, and have metadata using the new package repository system built on top of Git. Closing as solved.

from oh-my-fish.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.