You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+11-12Lines changed: 11 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -27,19 +27,21 @@ The catalog data is maintained in human-readable Tab-Separated Values (`.tsv`) f
27
27
> [!NOTE]
28
28
> This catalog is under active development and curation. Contributions and suggestions are highly encouraged!
29
29
30
-
## Contributing
31
-
... (rest of the README follows) ...
32
30
33
31
## Contributing
34
32
35
-
We welcome contributions to help grow and maintain this valuable resource! The OSAI catalog relies on community input.
33
+
We welcome contributions to help grow and maintain this resource. The OSAI ecosystem components relies on community input and updating to remain of value.
36
34
37
35
The contribution process is designed to be straightforward:
38
36
39
-
1.**Edit the TSV:** Identify the correct `.tsv` file in the `/data` directory for your component and add or modify the relevant line(s).
37
+
1.**Edit the TSV:** Identify the `ecosystem_components.tsv` file in the `/data` directory for your component and add or modify the relevant line(s).
40
38
2.**Submit a Pull Request (PR):** Propose your changes via a GitHub Pull Request. Please use the provided PR template to describe your contribution.
41
39
3.**Review:** The project maintainers will review your submission for relevance, accuracy, and formatting.
42
-
4.**Merge & Convert:** Once approved, your changes will be merged into the main `.tsv` file. The updated JSON file will be automatically generated shortly after.
40
+
4.**Merge & Convert:** Once approved, your changes will be merged into the main `ecosystem_components.tsv` file. The updated JSON file will be automatically generated shortly after.
41
+
42
+
After contributing:
43
+
1.**JSON Generation** The TSV will be converted automatically for web reusable JSON for example in other resources and made available with versioning under `ecosystem_components.tsv` file in the `/data`.
44
+
2.**Hosted online** The JSON will be used to feed the OSAI Ecosystem Components list on https://dome-ml.org/ai-ecosystem
43
45
44
46
**Please see our [Contribution Guidelines](CONTRIBUTING.md) for detailed instructions on formatting entries and the PR process.**
45
47
@@ -56,7 +58,7 @@ Information about the license can be found in [LICENSE.md](LICENSE.md). By contr
56
58
If you use this catalog in your work, please cite it. We recommend creating a `CITATION.cff` file in the repository root for standardized citation information.
57
59
58
60
*Placeholder Citation (update once finalized, possibly via CITATION.cff and Zenodo):*
59
-
> OSAI Community Contributors. (2025). *OSAI: Open and Sustainable AI Ecosystem Catalog*. GitHub Repository. https://github.com/[your-username]/OSAI *(Replace with actual URL)*
61
+
> OSAI Community Contributors. (2025). *OSAI: Open and Sustainable AI Ecosystem Catalog*. GitHub Repository. https://github.com/gavinf97/OSAI_ecosystem
60
62
61
63
See [CITATION.cff](CITATION.cff) (once created).
62
64
@@ -66,11 +68,8 @@ All participants are expected to adhere to the project's [Code of Conduct](CODE_
66
68
67
69
## Contact
68
70
69
-
For questions, suggestions, or to report issues, please open an [Issue](https://github.com/[your-username]/OSAI/issues)*(Replace with actual URL)* in this repository, or contact the maintainers at **[INSERT CONTACT METHOD HERE]**.
70
-
71
-
## Acknowledgements
71
+
For questions, suggestions, or to report issues, please open an [Issue](https://github.com/[your-username]/OSAI/issues)*(Replace with actual URL)* in this repository, or contact the maintainers at **gavinmichael.farrell@studenti.unipd.it**.
72
72
73
-
The structure and documentation approach of this repository drew inspiration from the excellent work done by the [Research Software Quality Kit (RSQKit)](https://github.com/EVERSE-ResearchSoftware/RSQKit) and ELIXIR's [Research Data Management Kit (RDMKit)](https://rdmkit.elixir-europe.org/).
73
+
## Acknowledgements - RSQkit & RDMkit
74
74
75
-
<!-- ## Funding
76
-
Optional: Add any relevant funding information here. -->
75
+
This repostiories structure and documentation approach draws direct inspiration and code from the excellent work done by the [Research Software Quality Kit (RSQKit)](https://github.com/EVERSE-ResearchSoftware/RSQKit) and ELIXIR's [Research Data Management Kit (RDMKit)](https://rdmkit.elixir-europe.org/).
0 commit comments