Skip to content

Commit 21833db

Browse files
Make repo DIF-community-ready: badges, CoC, issue templates
- Add DIF Contributor and W3C CCG Member badges to README - Update Contribute section with DIF Discord + CCG links - Add explicit DIF Code of Conduct reference to README and CONTRIBUTING.md - Add branch naming conventions and licensing section to CONTRIBUTING.md - Create 3 new issue templates: bug report, feature request, DID method discussion Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent efbb77a commit 21833db

5 files changed

Lines changed: 129 additions & 5 deletions

File tree

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
name: Bug Report
3+
about: Report a bug in the reference implementation or tooling
4+
title: "[BUG] "
5+
labels: bug
6+
assignees: ''
7+
---
8+
9+
## Component
10+
11+
*(e.g., @trailprotocol/core, CLI, examples)*
12+
13+
## Description
14+
15+
What happened?
16+
17+
## Expected Behavior
18+
19+
What did you expect to happen?
20+
21+
## Steps to Reproduce
22+
23+
1.
24+
2.
25+
3.
26+
27+
## Environment
28+
29+
- **OS:**
30+
- **Node.js version:**
31+
- **@trailprotocol/core version:**
32+
33+
## Additional Context
34+
35+
*(Logs, screenshots, related issues)*
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
name: DID Method Discussion
3+
about: Start a discussion about the did:trail method design, interoperability, or ecosystem alignment
4+
title: "[DISCUSSION] "
5+
labels: discussion
6+
assignees: ''
7+
---
8+
9+
## Topic
10+
11+
What aspect of `did:trail` do you want to discuss?
12+
13+
## Context
14+
15+
Why is this discussion relevant? Reference related standards, working groups, or implementations if applicable.
16+
17+
## Your Perspective
18+
19+
What is your position or question?
20+
21+
## Related Standards / Specifications
22+
23+
*(e.g., DIF TAAWG, W3C CCG, other DID methods, EU AI Act articles)*
24+
25+
## Discussion Points
26+
27+
- [ ]
28+
- [ ]
29+
- [ ]
30+
31+
---
32+
*Cross-posting to [W3C CCG](mailto:public-credentials@w3.org) or [DIF Discord](https://discord.gg/decentralized-identity) is encouraged for broader community input.*
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
name: Feature Request
3+
about: Suggest a new feature or enhancement
4+
title: "[FEATURE] "
5+
labels: enhancement
6+
assignees: ''
7+
---
8+
9+
## Summary
10+
11+
What feature or enhancement are you proposing?
12+
13+
## Motivation
14+
15+
Why is this needed? What problem does it solve?
16+
17+
## Proposed Solution
18+
19+
How should this work? Include API examples, DID document changes, or specification updates if applicable.
20+
21+
## Alternatives Considered
22+
23+
What other approaches did you consider?
24+
25+
## Specification Impact
26+
27+
Does this require changes to the `did:trail` specification? If so, which sections?
28+
29+
- [ ] DID Method Syntax (Section 4)
30+
- [ ] DID Document Structure (Section 5)
31+
- [ ] Method Operations (Section 6)
32+
- [ ] Trust Extensions (Section 7)
33+
- [ ] Other:

CONTRIBUTING.md

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,11 +65,31 @@ For minor fixes (typos, formatting), direct PRs are welcome.
6565

6666
## Code of Conduct
6767

68-
Be constructive. Technical disagreement is welcome; personal attacks are not.
68+
This project adheres to the [DIF Code of Conduct](https://github.com/decentralized-identity/org/blob/master/code-of-conduct.md). By participating, you agree to uphold its principles of open, inclusive, and collaborative engagement.
69+
70+
In short: Be constructive. Technical disagreement is welcome; personal attacks are not. Assume good intent. If conflicts arise, follow the [DIF escalation process](https://github.com/decentralized-identity/org/blob/master/code-of-conduct.md#reporting-guidelines).
6971

7072
## Community
7173

72-
TRAIL is developed in coordination with the [Decentralized Identity Foundation (DIF)](https://identity.foundation) and presented in the Trusted AI Agents Working Group (TAAWG). Join the [DIF Discord](https://identity.foundation/discord) to connect with other contributors.
74+
TRAIL is developed in coordination with:
75+
76+
- **[Decentralized Identity Foundation (DIF)](https://identity.foundation)** - Join the [DIF Discord](https://discord.gg/decentralized-identity) to connect with other contributors. Relevant channels: `#did-methods`, TAAWG working group channels.
77+
- **[W3C Credentials Community Group (CCG)](https://www.w3.org/community/credentials/)** - Mailing list: [public-credentials@w3.org](mailto:public-credentials@w3.org). Archive: [lists.w3.org](https://lists.w3.org/Archives/Public/public-credentials/)
78+
79+
## Branch Naming
80+
81+
When submitting PRs, please use one of these branch prefixes:
82+
83+
- `spec/` - Specification changes (e.g., `spec/add-key-rotation-section`)
84+
- `feat/` - New features or examples (e.g., `feat/python-resolution-example`)
85+
- `fix/` - Bug fixes (e.g., `fix/typo-in-did-syntax`)
86+
- `docs/` - Documentation improvements (e.g., `docs/update-roadmap`)
87+
88+
## Licensing
89+
90+
By contributing, you agree that your contributions will be licensed under the project's dual license:
91+
- **Specification contributions** (`.md` files in `spec/`): [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/)
92+
- **Code contributions**: [MIT License](https://opensource.org/licenses/MIT)
7393

7494
## Contact
7595

README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44

55
[![W3C DID Core 1.0](https://img.shields.io/badge/W3C-DID%20Core%201.0-blue)](https://www.w3.org/TR/did-core/)
66
[![VC Data Model 2.0](https://img.shields.io/badge/W3C-VC%202.0-blue)](https://www.w3.org/TR/vc-data-model-2.0/)
7+
[![DIF Contributor](https://img.shields.io/badge/DIF-Contributor-blue)](https://identity.foundation)
8+
[![W3C CCG Member](https://img.shields.io/badge/W3C%20CCG-Member-blue)](https://www.w3.org/community/credentials/)
79
[![License: CC BY 4.0](https://img.shields.io/badge/License-CC%20BY%204.0-lightgrey.svg)](https://creativecommons.org/licenses/by/4.0/)
810
[![License: MIT](https://img.shields.io/badge/Code-MIT-green.svg)](https://opensource.org/licenses/MIT)
911
[![Status: Draft](https://img.shields.io/badge/Spec-v1.1.0--draft-orange)](https://github.com/trailprotocol/trail-did-method/issues)
@@ -200,13 +202,15 @@ The `methods/trail.json` file in this repository is submitted for inclusion in t
200202

201203
## Contribute
202204

203-
We welcome contributions, questions, and challenges. If you find a flaw in the specification that's exactly what we want to know.
205+
We welcome contributions, questions, and challenges. If you find a flaw in the specification - that's exactly what we want to know.
204206

205207
- **Open an issue** for specification questions, security concerns, or improvement suggestions
206-
- **Join the discussion** at the W3C Credentials Community Group: [public-credentials@w3.org](mailto:public-credentials@w3.org)
208+
- **Submit a PR** - see [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines, branch naming, and review process
209+
- **Join DIF Discord** - connect with contributors in the [DIF Discord](https://discord.gg/decentralized-identity) (#did-methods, TAAWG channels)
210+
- **Join W3C CCG** - discuss `did:trail` on the mailing list: [public-credentials@w3.org](mailto:public-credentials@w3.org)
207211
- **Contact the author:** christian.hommrich@trailprotocol.org
208212

209-
See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
213+
This project follows the [DIF Code of Conduct](https://github.com/decentralized-identity/org/blob/master/code-of-conduct.md).
210214

211215
---
212216

0 commit comments

Comments
 (0)