Skip to content

Latest commit

 

History

History
73 lines (36 loc) · 2.91 KB

CONTRIBUTING.md

File metadata and controls

73 lines (36 loc) · 2.91 KB
Raw

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 involvement is vital for enhancing the comprehensiveness and effectiveness of our indicators. Below you will find detailed ways you can contribute to the project.

Accessing the GitHub Repository

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.

Contribution Guidelines

1. Familiarize Yourself with the Project

Start by understanding the scope and objectives of our project:

  • Review the documentation where the indicators are described.

  • Understand the existing indicators, their importance, and how they are used.

2. Explore Existing Issues

Look through the project's issue tracker 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.

3. Submit a New Issue

If you identify a potential improvement or have a new indicator in mind:

  • Submit a new issue detailing your idea.

  • Provide comprehensive details including the purpose of the indicator, its measurement methodology, and any relevant literature or examples.

4. Participate in Discussions

Engage actively in the discussions section:

  • 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

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.

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!