Skip to content

Commit 232f58f

Browse files
committed
Clean-up README - remove duplicate contributing guide
1 parent 50a60e2 commit 232f58f

1 file changed

Lines changed: 3 additions & 36 deletions

File tree

README.md

Lines changed: 3 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,8 @@ It uses the [voc4cat-tool](https://github.com/nfdi4cat/voc4cat-tool) and GitHub
1717
## Basic principles
1818

1919
Voc4cat makes contributing easy for everyone with a GitHub account.
20-
The process is essentially *(see further below for details,
21-
browse through our [step-by-step guide](https://nfdi4cat.github.io/voc4cat/docs_usage/published-guidelines-v2.html#contribution-step-by-step-guide),
22-
or read the guide in pdf form with screenshots of each step (https://zenodo.org/records/13757351)*.
20+
The process is essentially *(browse through our [step-by-step guide](https://nfdi4cat.github.io/voc4cat/docs_usage/how-to-contribute.html),
21+
or read the guide in pdf form with screenshots of each step (https://zenodo.org/records/13757351)*:
2322

2423
- Download the [most current vocabulary file (xlsx)](https://nfdi4cat.github.io/voc4cat/dev/voc4cat.xlsx),
2524
- Edit the vocabulary file in Excel,
@@ -78,44 +77,12 @@ Both services offer API access to voc4cat. Skosmos has more SKOS-specific featur
7877

7978
To discuss about the **voc4cat**-vocabulary maintained here, create an [issue](https://github.com/nfdi4cat/voc4cat/issues).
8079

81-
To contribute new concepts or collections or change existing ones, you may either submit your contributions as Excel/xlsx-file or (as an expert) as new/changed turtle file.
80+
To add new concepts or collections or change existing ones, please follow our [*"How to contribute?"*](https://nfdi4cat.github.io/voc4cat/docs_usage/how-to-contribute.html#) guide.
8281

8382
> Small contributions like adding a single concept are as valuable as bigger ones.
8483
> In fact if you plan a bigger change (50+ concepts), consider splitting up the additions/changes into smaller chunks
8584
> with max. ~20 changes to make the review process not too hard for the reviewers and you as author.
8685
87-
Here are the steps for submitting updates via Excel/xlsx:
88-
89-
<details>
90-
91-
- Get the Excel/xlsx-vocabulary file
92-
- The most recent version of the vocabulary is always available via GitHub-pages https://nfdi4cat.github.io/voc4cat/dev/voc4cat.xlsx
93-
- Make changes to the Excel file. If you want to add something new you need to [request a range of IDs](https://github.com/nfdi4cat/voc4cat/issues/new/choose) for you.
94-
- Create a fork of the voc4cat repository (if you don't yet have one) or pull the latest changes to your fork (via "Sync fork" button in GUI).
95-
- Create a feature branch for your contribution (via GitHub GUI or `git switch -c name-of-branch`)
96-
- Add the xlsx file to the feature branch into the folder `inbox-excel-vocabs`
97-
- The name of the file must match the vocabulary that you want to update. So do not change the filename, but keep `voc4cat.xlsx`.
98-
- Create a pull request with the updated Excel-file in this repository.
99-
- Please describe your changes and the motivation for the changes in the pull request note or link to an issue with this information.
100-
This will help reviewers to understand the proposed change and decide about it.
101-
- Your pull request will be processed automatically by a CI/CD pipeline that typically finishes in less than a minute.
102-
- Review the artifacts/logs generated by the CI pipeline.
103-
- The [workflow artifact](https://docs.github.com/en/actions/managing-workflow-runs/downloading-workflow-artifacts) will contain an updated xlsx file that is recreated from the updated turtle-files.
104-
- If all is good your contribution will be either
105-
- directly merged by the maintainers
106-
- or a discussion will be started about what else is needed
107-
- or why the proposed change may not fit.
108-
- If you need to fix something, first pull the changes made by the action with `git pull` (or "sync" in GUI) and then commit further changes to the pull request branch in your clone.
109-
- If any commits have been made by the CI pipeline, pull the changes to your repo (via "Sync fork" button in GUI) before committing any additional changes.
110-
111-
</details>
112-
113-
Finally, when the proposed pull request is accepted, your changes will be integrated in the vocabularies in the folder `vocabularies`.
114-
The vocabularies are stored in split form using one folder per vocabulary.
115-
Each concept, collection and concept scheme is stored in a separate file using the ID-part of the IRI as file name.
116-
117-
See [inbox-excel-vocabs/README.md](https://github.com/nfdi4cat/voc4cat/tree/main/inbox-excel-vocabs/README.md) for a minimal example how to test the submission process.
118-
11986
## How to suggest improvements to the tooling & template?
12087

12188
To discuss about the workflow for maintaining SKOS vocabularies based on this template, create an [voc4cat-template issue](https://github.com/nfdi4cat/voc4cat-template/issues).

0 commit comments

Comments
 (0)