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

Solid GitHub Repo Naming System #180

Closed
Mitzi-Laszlo opened this issue Dec 16, 2019 · 8 comments
Closed

Solid GitHub Repo Naming System #180

Mitzi-Laszlo opened this issue Dec 16, 2019 · 8 comments

Comments

@Mitzi-Laszlo
Copy link
Contributor

Perhaps we could make a naming system for repositories on Solid GitHub so that people, especially newcomers can search and navigate the work going on more easily?

Perhaps the repo overview will come in handy when designing the naming system.

What should be included in the name?

For example, the overarching aim might be helpful to include. Such as:

  • Specification_ (includes spec work)
  • Tools_ (includes any tools and libraries etc for implementing Solid)
  • Implementations_ (apps, Pods, and identity providers as well as other experiments around making user-facing products using Solid)
  • Websites_ (includes any website and general information repos)
  • Any more?
@justinwb
Copy link
Member

+1 to categorizing and organizing the repos so that people can navigate them better. We've suffered from a lack of this for a while now.

I'd like to suggest another option for consideration (as opposed to changing the repository name itself). My concern is that changing the name of a repo may be confusing for some who are already using it, but more importantly it locks us in to one single category, when many repos could represent multiple.

We could consider Github repository topics as an alternative. These are pretty easy to setup (you click on manage topics for a given repo), and tag the relevant topic(s). You can then search by topic within a github organization for other repositories with the same topic. For example, this is a result for repositories in the solid org with the "solid" topic.

If we pull together a base set of topic categories for solid, we could link to topic search results for each one (e.g. from the main search page or repo overview). This has the added advantage of being updated automatically whenever a repo is tagged with a given topic.

@RubenVerborgh
Copy link
Contributor

+1 to the idea of categorizing, and specifically the usage of repo topics. Just to show how handy these are: https://github.com/search?q=%23solid+%23slides&type=Repositories

That said, I repeat an earlier comment that "tools" and "implementations" are not the right categorization for what we do, so we'd have to work on that first.

@Mitzi-Laszlo
Copy link
Contributor Author

@justinwb great suggestion on using the GitHub topics tool.

Let's have a draft on which topics...

@HuVote

This comment has been minimized.

@HuVote

This comment has been minimized.

@Mitzi-Laszlo
Copy link
Contributor Author

This repo overview suggestion could be handy #172

@csarven
Copy link
Member

csarven commented Jul 1, 2020

Strong -1 to renaming/moving existing repositories. New repositories can use a URI template for common items eg. {panel-name}-panel, but wouldn't go overboard and ask for something weird like {tool-name}-tool.

+1 to labelling.

If research groups want their own space under the solid org, they can have a dedicated repo given to their team - but not the whole solid org!

@Mitzi-Laszlo
Copy link
Contributor Author

A specific proposal made on #207

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

No branches or pull requests

5 participants