Skip to content

Commit

Permalink
How to contribute
Browse files Browse the repository at this point in the history
  • Loading branch information
EvaMart committed May 8, 2024
1 parent 8b79bdc commit f5f4138
Showing 1 changed file with 36 additions and 1 deletion.
37 changes: 36 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1 +1,36 @@
# How to Contribute
# How to Contribute

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:

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)

1. Familiarize Yourself with the Project:

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.

2. Explore Existing Issues:

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.

3. Submitting a New Issue:

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.

4. Participate in Discussions:

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.

5. Proposing Changes:

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.


6. Spread the Word:

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.


Thank you for being part of our community!

0 comments on commit f5f4138

Please sign in to comment.