New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Repository status tracking/API #312

Open
jantman opened this Issue Dec 7, 2014 · 2 comments

Comments

Projects
None yet
3 participants
@jantman

jantman commented Dec 7, 2014

We all have projects that never took off, that are far from usable yet, or that are abandoned for one reason or another. What I propose is adding a single metadata field to each repository, called "status" (or maybe "release_status", or something less ambiguous). The value would be a single string (well, an enum / a fixed set of possibilities), and would be settable via the API and the repository Settings page.

Values could be something like:

  • Unknown (default)
  • Pre-release (not ready for public use yet)
  • Active (ready for use, under active development)
  • Inactive (ready for use, but not under active development)
  • Abandoned (ready for use, but no longer supported or developed at all)
  • Incomplete (not ready for use, no intent of doing further development)

Ideally, these could also show up as a column in search results, and would be displayed somewhere near the top of the repository and releases pages.

I've heard some people recommend using the Releases feature to handle this. However, even at best (assuming everyone uses semantic versioning correctly), this results in a trinary value - no releases, 0.x releases, and >=1.0 releases. This misses out on what is, in my opinion, the most valuable information: whether the project is in a usable state or incomplete, and whether the owner intends on continuing development.

This isn't just information that I want about other people's projects, and that I want to make available to other people (which I could do acceptably well in the README). It's also something I want for my own personal repositories and my employer's org repositories. I have ~90 repositories and my organization has well over 100, and it's quite a pain to figure out what the status of them all is.

@patcon

This comment has been minimized.

Show comment
Hide comment
@patcon

patcon Jan 18, 2015

Would be great to have a standard format where stuff like this could be read from the README (thinking like yaml front-matter, but maybe not so ugly :). I love github, but prefer the idea of keeping the smarts in the plaintext files, rather than in metadata only available via api :)

patcon commented Jan 18, 2015

Would be great to have a standard format where stuff like this could be read from the README (thinking like yaml front-matter, but maybe not so ugly :). I love github, but prefer the idea of keeping the smarts in the plaintext files, rather than in metadata only available via api :)

@davesann

This comment has been minimized.

Show comment
Hide comment
@davesann

davesann Jan 19, 2015

I would like to see something like this on all repos - and the ability to filter accordingly.

You could split this into 2

something like:

  1. Development Activity status or intention: Experiment, Active, Inactive, Maintenance Only, Abandoned
  2. Code/functionality status: Incomplete, alpha, beta, mature, deprecated or superseded.

(by deprecated or superseded - I mean to say that things change and the code may no longer have a relevant utility).

davesann commented Jan 19, 2015

I would like to see something like this on all repos - and the ability to filter accordingly.

You could split this into 2

something like:

  1. Development Activity status or intention: Experiment, Active, Inactive, Maintenance Only, Abandoned
  2. Code/functionality status: Incomplete, alpha, beta, mature, deprecated or superseded.

(by deprecated or superseded - I mean to say that things change and the code may no longer have a relevant utility).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment