1
- # [ WIP] processing-contributions
2
-
3
- > [ !WARNING]
4
- > This repository is a work in progress.
1
+ # processing-contributions
5
2
6
3
This repository maintains the contributions to Processing.
7
4
5
+ > [ !TIP]
6
+ > If you're ready to publish your contribution and have it appear in the Contribution Manager,
7
+ > submit it via our
8
+ > [ Github issue form] ( https://github.com/processing/processing-contributions/issues/new?assignees=&labels=new-contribution&projects=&template=new-contribution.yaml ) .
9
+
10
+
11
+ ## Technical information
12
+
8
13
All contributions are stored in a contributions database file in yaml format, ` contributions.yaml ` .
9
14
Consumers of this data are the Processing website, and the Processing application.
10
15
@@ -14,7 +19,7 @@ database. The `issue_to_pr.yml` workflow is triggered by a new issue for registe
14
19
It will then retrieve the properties file provided in the issue, parse and validate, and then if valid,
15
20
add the new information to the ` contributions.yaml ` database file in a new pull request.
16
21
17
- ## Data structure
22
+ ### Data structure
18
23
All contributions are stored in a contributions database file in yaml format, ` contributions.yaml ` .
19
24
Each entry contains the fields found in the properties file, such as
20
25
* The fields from the ` library.properties ` file are: ` name ` , ` version ` , ` prettyVersion ` ,
@@ -44,7 +49,7 @@ Additional fields are
44
49
updated. To have complete data for this field will require waiting for all libraries to be updated, or
45
50
will require some detective work into the archives.
46
51
47
- ## Scripts
52
+ ### Scripts
48
53
The scripts folder contains scripts in Python for parsing, validating, and processing the database
49
54
file and properties files.
50
55
@@ -65,7 +70,7 @@ folder, for consumption by the Processing website.
65
70
* ` utils.py ` : utility functions used by multiple script files.
66
71
67
72
68
- ## Outputs
73
+ ### Outputs
69
74
70
75
At this time, the website requires a folder of json files, where each json file is a separate
71
76
contribution. These files are created from the database using the script ` scripts/to_source_jsons.py ` .
0 commit comments