-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
87 additions
and
44 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,36 +1,59 @@ | ||
| # How to Contribute | ||
|
|
||
| How to Contribute to Our Collection of Research Software Quality Indicators | ||
| # How to Contribute to Our Collection of Research Software Quality Indicators | ||
|
|
||
| Thank you for your interest in contributing to our collection of research software quality indicators! Your contributions play a crucial role in improving the comprehensiveness and effectiveness of our project. Here's how you can get involved: | ||
| Accessing the GitHub Repository: | ||
| Thank you for your interest in contributing to our collection of research software quality indicators! Your involvement is vital for enhancing the comprehensiveness and effectiveness of our indicators. Below you will find detailed ways you can contribute to the project. | ||
|
|
||
| Our project is hosted on GitHub. If you're viewing this guide on our website and would like to contribute, you can access the GitHub repository by following this link: [Link to GitHub Repository](https://github.com/inab/FAIRsoft_indicators) | ||
| ## Accessing the GitHub Repository | ||
|
|
||
| 1. Familiarize Yourself with the Project: | ||
| Our project is hosted on GitHub. If you're reading this guide on our website and would like to contribute directly, please visit the [FAIRsoft Research Quality Indicators Repository](https://github.com/inab/FAIRsoft_indicators). | ||
|
|
||
| Before contributing, take some time to familiarize yourself with our project and its goals. Browse through the repository where the indicators specification "lives" to understand the existing indicators and their documentation. | ||
| ## Contribution Guidelines | ||
|
|
||
| 2. Explore Existing Issues: | ||
| ### 1. Familiarize Yourself with the Project | ||
|
|
||
| Check the repository's [issue tracker](https://github.com/inab/FAIRsoft_indicators/issues) for existing issues related to the indicators. These issues may include suggestions for new indicators, discussions about existing ones, or requests for clarification. | ||
| Start by understanding the scope and objectives of our project: | ||
| - Review the [documentation](https://github.com/inab/FAIRsoft_indicators/tree/main/docs/indicators) where the indicators are described. | ||
| - Understand the existing indicators, their importance, and how they are used. | ||
|
|
||
| 3. Submitting a New Issue: | ||
| ### 2. Explore Existing Issues | ||
|
|
||
| If you have an idea for a new indicator or would like to suggest improvements to an existing one, you can submit a [new issue](https://github.com/inab/FAIRsoft_indicators/issues/new). Please provide as much detail as possible, including the rationale behind your suggestion and any relevant references. | ||
| Look through the project's [issue tracker](https://github.com/inab/FAIRsoft_indicators/issues) to find ongoing discussions, requests for enhancements, or reports of bugs: | ||
| - Identify areas where you can contribute or propose new ideas. | ||
| - Issues might include suggestions for new indicators, refinements of existing ones, or technical improvements. | ||
|
|
||
| 4. Participate in Discussions: | ||
| ### 3. Submit a New Issue | ||
|
|
||
| Engage in [discussions](https://github.com/inab/FAIRsoft_indicators/discussions) on existing issues by sharing your thoughts, providing feedback, or offering solutions. Your input can help refine and clarify the indicators, ensuring they accurately reflect best practices in research software quality. | ||
| If you identify a potential improvement or have a new indicator in mind: | ||
| - Submit a [new issue](https://github.com/inab/FAIRsoft_indicators/issues/new) detailing your idea. | ||
| - Provide comprehensive details including the purpose of the indicator, its measurement methodology, and any relevant literature or examples. | ||
|
|
||
| 5. Proposing Changes: | ||
| ### 4. Participate in Discussions | ||
|
|
||
| If you're comfortable with Git and GitHub, you can fork the repository, make your proposed changes, and submit a pull request. Be sure to follow any guidelines or conventions outlined in the repository's contributing guidelines. | ||
| Engage actively in the [discussions section](https://github.com/inab/FAIRsoft_indicators/discussions): | ||
| - Share your insights, provide feedback, and help refine proposals. | ||
| - Discussions are great platforms for brainstorming and collaborating on new ideas. | ||
|
|
||
| ### 5. Propose Changes via Pull Requests | ||
|
|
||
| 6. Spread the Word: | ||
| If you're familiar with GitHub and Git: | ||
| - Fork the repository, create a new branch for your changes, and develop your enhancements. | ||
| - Submit a pull request with a clear description of your changes and reference any related issue(s). | ||
| - Follow any coding standards and guidelines provided in the repository. | ||
|
|
||
| Help us reach a broader audience by sharing our project with others who may be interested. Whether through social media, academic networks, or research communities, spreading awareness can attract more contributors and enrich our discussions. | ||
| ### 6. Review Contributions | ||
|
|
||
| Participate in the review process by providing constructive feedback on other contributors' pull requests. | ||
|
|
||
| ### 7. Spread the Word | ||
|
|
||
| Help expand our community: | ||
| - Share the project within your networks. | ||
| - Present the indicators at workshops, seminars, and conferences. | ||
| - Encourage your peers to contribute. | ||
|
|
||
| ## Stay Connected | ||
|
|
||
| Follow the repository to stay updated on new discussions, issues, and updates. Your ongoing engagement is crucial for the project's success. | ||
|
|
||
| Thank you for being a part of our community and contributing to the advancement of research software quality indicators! | ||
|
|
||
| Thank you for being part of our community! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,9 +1,38 @@ | ||
|
|
||
| # FAIRsoft: FAIR indicators for research software | ||
| # FAIRsoft Research Quality Indicators | ||
|
|
||
| This repository contains the documentation for the FAIRsoft indicators, measured by [OpenEBench Software Observatory](https://openebench.bsc.es/observatory). | ||
| Welcome to the FAIRsoft Research Quality Indicators repository. This repository hosts the specification of various indicators that measure and evaluate the quality of research software. These indicators are designed to be automatically evaluated and have been utilized both in academic publications and within the broader software observatory ecosystem. | ||
|
|
||
| ## About the Indicators | ||
|
|
||
| # Credits | ||
| The indicators are detailed in the `docs/indicators` directory in Markdown format. Each indicator includes: | ||
|
|
||
| - **Name**: The title of the indicator. | ||
| - **What does it measure?**: The aspect of software quality being measured. | ||
| - **Why is it important?**: The relevance of the metric to overall software quality. | ||
| - **How is it measured?**: Methodology used to evaluate the metric. | ||
| - **Type of software it applies to**: Classifications of software the indicator is applicable to. | ||
| - **Weight**: The importance of the indicator in the overall evaluation. | ||
|
|
||
| These indicators are crucial for developers, researchers, and analysts interested in assessing the quality of software in a structured and quantifiable manner. | ||
|
|
||
| ## MkDocs Page | ||
|
|
||
| The contents of this repository are used to render an MkDocs page, which serves as a user-friendly web interface to view the indicators. Visit our MkDocs page to see the indicators presented in a well-organized format. | ||
|
|
||
| ## Contributing | ||
|
|
||
| We actively encourage community contributions to evolve and refine these indicators. Please refer to the `CONTRIBUTING.md` file for guidelines on how to propose changes, discuss improvements, and submit patches. | ||
|
|
||
| ### Issues and Discussions | ||
|
|
||
| Use the repository's issue tracker and discussions feature to suggest enhancements, ask questions, and connect with other community members. Your input helps make these indicators more robust and applicable across different contexts. | ||
|
|
||
| ## Publications and Usage | ||
|
|
||
| The indicators have been employed in academic research and are part of a larger effort to standardize the assessment of software quality. They are designed to be automatically evaluated, ensuring consistency and objectivity in results. | ||
|
|
||
| ## Software Observatory | ||
|
|
||
| The indicators have been integrated into the software observatory framework, where they help monitor and analyze software quality across various projects and platforms. | ||
|
|
||
| This project uses [MkDocs Material Theme](https://github.com/squidfunk/mkdocs-material) and [mkdocs-template](https://github.com/Andre601/mkdocs-template). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,37 +1,28 @@ | ||
| # Welcome! | ||
|
|
||
| # Welcome to FAIRsoft Indicators! | ||
|
|
||
| Designed to be measured in an automated way, the FAIRsoft indicators offer an efficient means of evaluating research software FAIRness, enabling developers and stakeholders to optimize the impact and longevity of their software. | ||
| The FAIRsoft indicators are meticulously designed to automatically measure the FAIRness (Findability, Accessibility, Interoperability, and Reusability) of research software. By leveraging these indicators, developers and stakeholders can greatly enhance the impact and sustainability of their software projects. | ||
|
|
||
| Feel free to explore the indicators in detail and learn how to apply them to your software projects at the [Indicators](./indicators/index.md) section. | ||
| Explore the indicators in depth and learn how to integrate them into your software initiatives in the [Indicators](./indicators/index.md) section. | ||
|
|
||
| --- | ||
|
|
||
| Below are some useful links and resources to help you get started and learn more about what we do: | ||
| ## Quick Links | ||
|
|
||
| 🚀 **Quick Links:** | ||
| 🚀 **Navigate Easily:** | ||
|
|
||
| - [GitHub Repository](https://github.com/yourusername/yourrepository): Explore the codebase, contribute, or star the repository to show your support! | ||
| - [Software Observatory](https://yoursoftwareobservatorypage.com): Learn more about our project's presence in the wider software ecosystem and its impact. | ||
| - [**GitHub Repository**](https://github.com/yourusername/yourrepository): Dive into our codebase, contribute to the project, or star the repository to show your support! | ||
| - [**Software Observatory**](https://yoursoftwareobservatorypage.com): Discover how our project fits into the broader software ecosystem and learn about its significant impacts. | ||
|
|
||
| 📄 **Additional Resources:** | ||
| 📄 **Discover More:** | ||
|
|
||
| - [About the Project](about.md): Learn about the goals, objectives, and contributors behind our project. | ||
| - [Contact Us](contact.md): Reach out to the project maintainers or team members with questions, feedback, or collaboration opportunities. | ||
| - [**About the Project**](about.md): Understand the ambitions, objectives, and the people behind our initiatives. | ||
| - [**Contact Us**](contact.md): Have questions or ideas? Connect with the project maintainers or team members for discussions and potential collaborations. | ||
|
|
||
| --- | ||
|
|
||
| ## Our Indicators are Evolving! 📈 | ||
|
|
||
| **Our Indicators are Evolving!** 📈 | ||
| We are committed to continuously enhancing and broadening our collection of software quality indicators. Community contributions play a pivotal role in this process. Your insights, suggestions, and active involvement are crucial to our collective success. Let’s work together to elevate the standards of research software quality! | ||
|
|
||
| We are constantly improving and expanding our set of software quality indicators. Contributions from the community are highly encouraged and welcomed. If you have ideas, suggestions, or would like to contribute, please don't hesitate to get involved. Together, we can make a difference in the world of research software quality! | ||
| > Interested in making a difference? Check out our [Contributing Guidelines](./CONTRIBUTING.md) to get started! | ||
| > If you are interested in contributing, please refer to our [Contributing Guidelines](./CONTRIBUTING.md) for more information. | ||
| --- | ||
|
|
||
| **Citation:** | ||
|
|
||
| If you use our indicators or find them useful in your research, please consider citing our publication: | ||
|
|
||
| [Author(s). (Year). Title of the Paper. Journal Name, Volume(Issue), Page Range. DOI or URL](https://linktoyourpaper.com) |