Document your code
Every project on GitHub comes with a version-controlled wiki to give your documentation the high level of care it deserves. It’s easy to create well-maintained, Markdown or rich text documentation alongside your code.
Sign up for free See pricing for teams and enterprisesVerified Tag
The following is a work-in-progress feature for the TFB project. This page will be moved within this Wiki if and when the feature described here is completed.
Introducing tags as a general concept
We are underway with an effort to measure and provide a score for hardware performance, and as part of that work, we are introducing a notion of tagging frameworks in their metadata files.
Some tags will yield a special icon in the results web site. For example, the TPR tag (which identifies the frameworks used to measure hardware performance) may end up looking like a T in a diamond:
Indicating official support with a "Verified" tag
We want to provide another tag that, where appropriate, indicates a special and important attribute of a framework's test implementations: The maintainer of the framework has reviewed and vouches for the implementation. In brief, a "Verified" flag (or tag).
Visual indicator on results web site
Our ulterior motive is to encourage maintainers to help us by reviewing the implementations we receive for their framework. And many maintainers already do so (thank you!) and we want to acknowledge that. The results web site would include a small indicator signifying a verified test implementation—something like the verified check on Twitter.
Verification process
This is still a work in progress idea, but we're imagining a very simple verification process:
- If you are a maintainer, just add a "verified" tag to your project metadata using the GitHub profile that we can obviously associate with your framework. When reviewing your PR, we'll easily recognize you as the maintainer and merge in the change.
- If you are not the maintainer, ping the maintainer on a Pull Request with the above metadata change and just have the maintainer agree to the verified status.