Skip to content

Commit 418fa9b

Browse files
committed
contributing support
1 parent a783e10 commit 418fa9b

File tree

1 file changed

+85
-0
lines changed

1 file changed

+85
-0
lines changed

CONTRIBUTING.md

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
# Contributing to `schema.datacite.org-linked-data`
2+
3+
Thanks for contributing.
4+
5+
This repository contains linked-data schema artifacts for DataCite metadata, including:
6+
7+
- class definitions
8+
- property definitions
9+
- controlled vocabularies (terms)
10+
- JSON-LD contexts
11+
- manifests
12+
- documentation and index pages
13+
14+
## How to Contribute
15+
16+
Use the workflow below so design discussion and implementation tracking stay clear.
17+
18+
## Discussions vs Issues
19+
20+
Use **GitHub Discussions** for:
21+
22+
- RFCs / proposals
23+
- schema design questions
24+
- vocabulary additions or changes
25+
- context / manifest design changes
26+
- breaking-change discussions
27+
- requests for feedback before implementation
28+
29+
Use **GitHub Issues** for:
30+
31+
- accepted implementation work
32+
- bugs
33+
- actionable tasks
34+
- follow-up items tied to a decision
35+
36+
Recommended flow:
37+
38+
1. Open a Discussion (RFC / proposal)
39+
2. Gather feedback and refine the proposal
40+
3. Maintainers record a decision (`Accepted`, `Rejected`, `Deferred`)
41+
4. Open Issue(s) for implementation (if accepted)
42+
5. Submit PR(s)
43+
44+
## RFC Proposals
45+
46+
If you are proposing a change, please use the RFC structure in:
47+
48+
- `.github/DISCUSSION_TEMPLATE/rfc.md`
49+
50+
At minimum, include:
51+
52+
- summary
53+
- problem statement
54+
- goals / non-goals
55+
- proposed change
56+
- examples (where possible)
57+
- compatibility / migration impact
58+
- alternatives considered
59+
- open questions for reviewers
60+
61+
## Pull Requests
62+
63+
When submitting a PR:
64+
65+
- link the relevant Discussion and/or Issue
66+
- describe what changed and why
67+
- note any manifest/context regeneration performed
68+
- include examples or screenshots for documentation/index-page changes
69+
70+
## Local Maintenance (Manifest and Index Pages)
71+
72+
If your changes affect schema artifacts, manifests, or directory indexes, these scripts may be relevant:
73+
74+
- `node scripts/manifest-sync.js --check`
75+
- `node scripts/manifest-sync.js --write --validate`
76+
- `node scripts/generate-index-pages.js`
77+
78+
## Community Expectations
79+
80+
Please keep contributions and discussions:
81+
82+
- respectful
83+
- specific
84+
- evidence-based
85+
- focused on clear technical outcomes

0 commit comments

Comments
 (0)