OpenMined / .github

All our community health files
Apache License 2.0
7 stars 13 forks source link

Configure org level topic standards #3

Open simcof opened 4 years ago

simcof commented 4 years ago

It is currently difficult for the public and OpenMined community members to explore and discover the 50+ repositories that this organisation houses. This issues proposes to apply a standard to applying topics for OpenMined repos.

The benefits are:

Terminology

Topic - A tag applied at the repository level that provides a brief description of a related subject

Repository name (also "repo name") - This is the literal name of the GitHub repository

The Convention

Each repository will have the following topics applied:

  1. Capability (or capabilities) - Minimum of one core OpenMined capability. Some repos will apply to more than one capability
  2. Languages / Frameworks - Versioning should not included. This should generally only include one or two (e.g. Python and TensorFlow is fine, no need to include Numpy, Pandas etc...). The non-technical repos should include descriptive terms like "templates", "graphics" etc...
  3. Related Products - Once OpenMined's updated Product Roadmap is published, any related products need to be included as topics
  4. Repo owners discretion - The repo owner may add additional topics that apply to the repos.

Capabilities

Languages / Tools / Frameworks

Products

To be completed once road map is released

karlhigley commented 4 years ago

What does the syft capability label indicate?

Nolski commented 4 years ago

I'm not really sure what sort of capability labels something like Threepio would have. Its main function is allowing for greater interoperability between various frameworks so perhaps something like interoperability would be a useful capability label to have?

cereallarceny commented 4 years ago

@Nolski translation maybe too?

cereallarceny commented 4 years ago

Overall I generally like this list @simcof.

cereallarceny commented 4 years ago

I think we can close @simcof, yeah?