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
+22-7Lines changed: 22 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -29,17 +29,32 @@ The list data is maintained in human-readable Tab-Separated Values (`.tsv`) file
29
29
30
30
## Contributing
31
31
32
-
We welcome contributions to help grow and maintain this resource. The **OSAI Ecosystem Components List** relies on community input and updates to remain valuable.
32
+
We welcome contributions to help grow and maintain this resource. The **OSAI Ecosystem Components List** relies on community input and updates to remain valuable.
33
33
34
-
The contribution process is designed to be straightforward:
34
+
We have two straightforward ways to submit a new tool or component:
35
35
36
-
1.**Edit the .yml file:** Locate the `ecosystem_components.yml` file in the `/data` directory. Add a new component using the template and correct fields or modify existing lines.
37
-
2.**Submit a Pull Request (PR):** Propose your changes via a GitHub Pull Request. Please use the provided PR template to describe your contribution.
38
-
3.**Review:** The project maintainers will review your submission for relevance, accuracy, and formatting.
39
-
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 thereafter.
36
+
### Option 1: Submit an Issue (Recommended)
37
+
The easiest way to propose a new addition is to use our structured GitHub Issue form.
38
+
39
+
1. Navigate to the [Issues tab](../../issues) in this repository.
40
+
2. Click **New Issue** and select the **Submit a New AI Ecosystem Component** template.
41
+
3. Fill out the provided fields with the tool details.
42
+
4. Submit the issue. Project maintainers will review the submission and add it directly to the dataset.
43
+
44
+
### Option 2: Submit a Pull Request (PR)
45
+
If you prefer working directly with the code, you can add entries to the dataset yourself.
46
+
47
+
1.**Edit the .yml file:** Locate the `ecosystem_components.yml` file in the `/data` directory. Add a new component using the blank template provided at the bottom of the file.
48
+
2.**Submit a Pull Request:** Propose your changes via a GitHub PR, describing your contribution.
49
+
3.**Review:** The project maintainers will review your submission for relevance, accuracy, and formatting.
50
+
4.**Merge & Convert:** Once approved, your changes will be merged into the main file, and the updated JSON will be automatically generated.
40
51
41
52
After contributing:
42
-
1.**Hosted Online:** The JSON will be used to populate the **OSAI Ecosystem Components List** on [https://dome-ml.org/ai-ecosystem](https://dome-ml.org/ai-ecosystem).
53
+
1.**Hosted Online:** The JSON will be used to populate the **OSAI Ecosystem Components List** on [https://dome-ml.org/ai-ecosystem](https://dome-ml.org/ai-ecosystem).
54
+
55
+
Please see our [Contribution Guidelines](CONTRIBUTING.md) for detailed instructions on formatting entries and the PR process.
56
+
57
+
The OSAI project is maintained by the **project maintainers**, who review contributions and manage the repository.
43
58
44
59
**Please see our [Contribution Guidelines](CONTRIBUTING.md) for detailed instructions on formatting entries and the PR process.**
0 commit comments