Skip to content

Commit b27b462

Browse files
committed
readme with link to issue page, remove wip
1 parent 19fa371 commit b27b462

File tree

1 file changed

+12
-7
lines changed

1 file changed

+12
-7
lines changed

README.md

+12-7
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,15 @@
1-
# [WIP] processing-contributions
2-
3-
> [!WARNING]
4-
> This repository is a work in progress.
1+
# processing-contributions
52

63
This repository maintains the contributions to Processing.
74

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+
813
All contributions are stored in a contributions database file in yaml format, `contributions.yaml`.
914
Consumers of this data are the Processing website, and the Processing application.
1015

@@ -14,7 +19,7 @@ database. The `issue_to_pr.yml` workflow is triggered by a new issue for registe
1419
It will then retrieve the properties file provided in the issue, parse and validate, and then if valid,
1520
add the new information to the `contributions.yaml` database file in a new pull request.
1621

17-
## Data structure
22+
### Data structure
1823
All contributions are stored in a contributions database file in yaml format, `contributions.yaml`.
1924
Each entry contains the fields found in the properties file, such as
2025
* The fields from the `library.properties` file are: `name`, `version`, `prettyVersion`,
@@ -44,7 +49,7 @@ Additional fields are
4449
updated. To have complete data for this field will require waiting for all libraries to be updated, or
4550
will require some detective work into the archives.
4651

47-
## Scripts
52+
### Scripts
4853
The scripts folder contains scripts in Python for parsing, validating, and processing the database
4954
file and properties files.
5055

@@ -65,7 +70,7 @@ folder, for consumption by the Processing website.
6570
* `utils.py`: utility functions used by multiple script files.
6671

6772

68-
## Outputs
73+
### Outputs
6974

7075
At this time, the website requires a folder of json files, where each json file is a separate
7176
contribution. These files are created from the database using the script `scripts/to_source_jsons.py`.

0 commit comments

Comments
 (0)