Contribute

Contribute to ediverse

ediverse is an open community project. Four contribution paths are available, from flagging a typo to authoring a fully sourced new page.

Four ways to contribute

Readers may contribute at the level of effort that suits them, from a one-off report to authoring a full page:

1. Report a fix — a typo, a dead link, a flawed example, a stale fact. A GitHub issue with the URL of the affected page and the nature of the correction is enough. Ideal when readers are not aiming to become editors.
2. Propose a new page — a missing EDIFACT segment, an under-documented message, a new standard. The proposal starts as an issue, then becomes a pull request once the scope is validated.
3. Sponsor the project — subscribing to the monthly newsletter indirectly funds editorial time. Formal sponsorship through GitHub Sponsors is open to companies wishing to be listed on the acknowledgements page (with no editorial consideration in return).
4. Share — cite a page in an article, a course, a Stack Overflow answer, or an internal integration handbook. Citation with a link grows the visibility of the project and prompts other practitioners to contribute.

Editorial contribution workflow

For an editorial contribution to be acceptable, it must follow the same process as internal authoring. The contributor opens an issue first, providing:

• the nature of the proposed addition or fix;
• the URL of the primary source that justifies the content (for example a UN/CEFACT file, a cXML DTD, an IETF RFC);
• the licence of that source (open, proprietary, paywalled);
• a brief justification of the value for the EDI community.

Once the issue is accepted by the editorial team, the contributor opens a pull request. The pull request must:

• pass the typecheck pnpm typecheck and the build pnpm build;
• archive the primary source under content/_sources/ with a PROVENANCE.md file;
• respect the editorial tone: third person, no informal address, sourced citations, original didactic examples for proprietary specifications;
• provide a parallel FR/EN translation, or explicitly mark the page as partial pending later translation.

Sourcing policy

The rule is strict: no technical fact may be published without a citation. Three categories of sources are admissible:

• Open public sources: UNECE UN/EDIFACT directories, OASIS UBL profiles, OpenPEPPOL profiles, IETF RFCs. Fully reproducible, with attribution.
• Restricted public sources: ANSI ASC X12 public index (transaction set names and codes), SAP OCI reference PDFs. Only the elements made public by the publisher may be cited; the detail of Implementation Guides remains out of scope.
• Paid proprietary sources: ISO 9735, X12 TR3, and similar. Not reproducible. Editorial coverage is limited to the conceptual level and original didactic examples consistent with fair-citation rights.

Code of conduct

All interactions on the public repository — issues, pull requests, discussions — are governed by a code of conduct modelled on the Contributor Covenant. The guiding principle is simple: technical discussions, mutual respect, focus on the content rather than on individuals. The full code will be published at the repository root when public contributions are formally opened.

Contributor recognition

Every accepted contribution is tracked through Git history and tied to an identifier published in the repository. Contributors who wish to may appear on the acknowledgements page. ediverse does not require copyright assignment: contributors retain their moral rights on their contribution and grant a usage licence compatible with the editorial licence of the site.

Contact

For any question preceding a significant contribution, or to report a legal issue (copyright, trademark, personal data), the reference contact is contact@ediverse.io. Ordinary technical correspondence goes directly through the GitHub repository.