Skip to content
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

AppStream information to prospect contributors #125

Open
aleixpol opened this issue Aug 1, 2017 · 7 comments
Open

AppStream information to prospect contributors #125

aleixpol opened this issue Aug 1, 2017 · 7 comments

Comments

@aleixpol
Copy link
Collaborator

aleixpol commented Aug 1, 2017

One thing I'd like to look into is implementing a series of features that should help users become contributors. I thought that a good place where to include the extra information would be AppStream

What I suggest is to extend the <url/> tag with two aditional types: contribute and vcs (i.e. version control system, a different tag could help. contribute would link to a main contribute page if available and vcs would actually link to the git repository (or similar).

For example, for appstream itself it would be:

  <url type="homepage">https://www.freedesktop.org/wiki/Distributions/AppStream/</url>
  <url type="vcs">https://github.com/ximion/appstream.git</url>
  <url type="contribute">https://github.com/ximion/appstream/</url>

The end goal is that the system should have all the information required to lead the user from an application to its sources and the community that manages them.

@ximion
Copy link
Owner

ximion commented Aug 2, 2017

@hughsie What do you think?
IMO having a "contribute" url type makes sense, having a "vcs" tag though is less helpful. Nobody would fork the project directly from the software center and hack on it, and the contribution page would for sure link to the VCS somewhere.
A contributor landing page would have some value though (although I am not sure how this would look like in the UI - if a project has set all the URL types, we would have quite a pile of links.) Also, a "contribute" url would have quite a big overlap with the existing "translate" url type.

@aleixpol
Copy link
Collaborator Author

aleixpol commented Aug 2, 2017

FWIW I never said this was meant to be used from a software center, but rather an IDE or even the shell itself.

@hughsie
Copy link
Collaborator

hughsie commented Aug 2, 2017

I don't think it hurts to add, but I too am a bit confused exactly where it's going to be shown.

@aleixpol
Copy link
Collaborator Author

I need to run it by our design team still but the idea is that if KDevelop (or any IDE if someone else is interested) we get to have.

Here's few ideas for further context:

  • In KDevelop we have a view for fetching projects from different sources. We have a KDE and a GitHub plugin, we could also have an AppStream one where the git URI comes from this metadata in discussion.
    spectacle ud1066

  • We could also have a "Contribute..." button in the shell provided the information is offered and an IDE installed on the system. Another place could be the window decoration (which for us is shared).
    spectacle x10783

@basak
Copy link

basak commented Dec 18, 2020

I don't think it hurts to add, but I too am a bit confused exactly where it's going to be shown.

In Ubuntu, I'm working on a tool that makes it easy to clone, patch and rebuild distribution source packages using git. Being able to automatically add an "upstream" remote would be really useful (for example to easily cherry-pick an upstream patch into a distribution release package version). This would need the upstream remote URL to be in metadata somewhere, and AppStream seems like the obvious place to put it.

Note that I would need a useable git URL, which isn't necessarily the same as a user-browseable one for all upstreams. In Debian packaging, we have Vcs: and Vcs-Browser. The former is something you can clone; the latter is something that works in a browser. So please specify both use cases so that we can reliably automate.

@cassidyjames
Copy link

I really like a "Contribute" URL as that seems handy to expose to users, especially through a software center. A way to point to a machine-friendly code repository itself seems interesting, but I think these should be separate considerations.

@btkostner
Copy link

Thinking about how elementary plans to deploy a flatpak repository, a vcs link would be useful for reverse lookup. Say someone gives https://github.com/danrabbit/harvey, it would be nice to parse our current appstream file to find the latest details of the application.

We could use a database to store all of this stuff, but it would be nicer and more robust by just parsing the already existing appstream data.

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

No branches or pull requests

6 participants