coateshl / metrics-toolkit Goto Github PK

The Metrics Toolkit provides evidence-based information about research metrics across disciplines, including how each metric is calculated, where you can find it, and how each should (and should not) be applied. It also includes examples of how to use metrics in grant applications, CVs, and promotion dossiers.

There are two ways to use the Toolkit. Explore metrics to browse the metrics you want to learn more about. Or, you can choose metrics that will be best for your use case by filtering via our broad discipline, research output, and impact type categories.

The Metrics Toolkit was developed thanks to the 2016 Force11 PitchIt! Innovation grant, as well as support from Oregon Health & Science University, IUPUI, and Altmetric.

Website

You can find our website here: http://www.metrics-toolkit.org/

Documentation

We developed a schema to consistently describe all of the metrics documented in the Metrics Toolkit. The schema and metrics files are stored in the Metrics folder of this repository.

We welcome community contributions to the Metrics Toolkit, including suggestions for new metrics and updates to our metrics descriptions.

The following is a set of guidelines for contributing to Metrics Toolkit. These are guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a issue or pull request.

Issues are a great way to for you to communicate your suggestions and see what we've already identified for discussion or enhancements.

• To view or create an issue, click on the Issues tab at the top of the repository.
  • Browse the open issues. If there's an exisitng issue that is related to your idea, feel free to add a comment. Hint: Click on the Issue title to view its details and comment
• Or, open a new issue, add a descriptive title, and leave a comment with the details you'd like to share.

Are you pretty confortable working in Github or just want to learn? That's awesome, direct contributions to the Metrics Toolkit are welcome! Here are a few tips for faciliating the Pull Request (PR) process:

• Make your changes compact, which will allow us to review and merge your contribuitons more quickly.
• Use a descriptive title.
• Add some comments to contextualize your contribution.

New to working in Github? No worries, this guide provides a nice overview of contributing to open projects on Github.

In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.

Please familiarize yourself with our Code of Conduct, which applies both within project spaces and in public spaces when an individual is representing the project or its community.

Except where otherwise noted, this work is licensed under a Creative Commons Attribution 4.0 International License.