Skip to content

contribute.md

Latest commit

 

History

History
206 lines (135 loc) · 6.32 KB

contribute.md

File metadata and controls

206 lines (135 loc) · 6.32 KB
Raw

Contribute to the Catalogue

Help grow the European mobility tools ecosystem by contributing tools, improvements, and feedback.

How to Submit a Tool

We welcome tool submissions from developers, organisations, and mobility data professionals. The submission process is designed to be simple while ensuring quality and relevance.

Submission Process

  1. Check if tool fits by reviewing our criteria below
  2. Gather information listed in required information
  3. Start a discussion in our GitHub Discussions with the "Tool Submission" category
  4. Wait for review of your submission by the NAPCORE team and the community
  5. Finish Documentation after approval, we'll help create the tool page
  6. Publication of the tool in the catalogue!

Tool Inclusion Criteria {#open-tool-criteria}

To be included in the catalogue, tools should meet these criteria:

Essential Requirements

  • ✅ Relevant to mobility data: Supports European mobility data standards or workflows
  • ✅ Publicly accessible: Available for use (either open source or free to use)
  • ✅ Functional: Currently working and maintained
  • ✅ Documented: Has basic documentation or usage instructions

Preferred Characteristics

  • 🌟 Open source: Open source tools are preferred
  • 🌟 Standards-compliant: Supports recognised European mobility standards
  • 🌟 Actively maintained: Regular updates and responsive to issues
  • 🌟 Community-driven: Open to contributions and feedback
  • 🌟 Well-documented: Comprehensive documentation and examples

We Also Welcome

  • Commercial tools with free tiers or community editions
  • Research prototypes or Work-in-progress tool that demonstrate innovative approaches and/or show promise
  • Internal tools that organizations are willing to share

Required Information

When submitting a tool, please provide:

Basic Information

  • Tool name
  • Brief description (1-2 sentences)
  • Category (Validators, Converters, SDKs, etc.)
  • Current status (Active, Maintenance, Beta, etc.)

Links

  • Live demo or website (if applicable)
  • Source code repository (if open source)
  • Documentation
  • Issue tracker

Technical Details

  • Standards supported (DATEX II, NeTEx, SIRI, mobilityDCAT-AP, etc.)
  • License (MIT, Apache, GPL, proprietary, etc.)
  • Maintenance status (actively maintained, maintenance mode, etc.)
  • Key features (3-5 bullet points)

Context

  • Target audience (who should use this tool?)
  • Use cases (when should this tool be used?)
  • Developer/Organization
  • Development history (optional but helpful)

Optional but Helpful

  • Screenshots or demo videos
  • Related tools or dependencies
  • Known limitations
  • Future roadmap

Submission Template

**Tool Name**: [Your Tool Name]

**Category**: [Select: Validators / Converters / SDKs / etc.]

**Brief Description**:  
[1-2 sentence description of what the tool does]

**Links**:

- Webpage: [URL]
- Source Code: [URL]
- Documentation: [URL]
- Repository: [URL]
- Demo: [URL]

**Standards Supported**: [DATEX II / NeTEx / SIRI / mobilityDCAT-AP / Other]

**License**: [MIT / Apache / GPL / Proprietary / Other]

**Status**: [Active / Maintenance / Beta / Deprecated]

**Key Features**:

- Feature 1
- Feature 2
- Feature 3

**Target Audience**: [Who should use this?]

**Use Cases**: [When should this tool be used?]

**Additional Information**: [Anything else we should know?]

Review Process

What Happens After Submission?

  1. Initial Review (1-3 days): Managing team checks if submission meets basic criteria
  2. Community Input (3-7 days): Community members can provide feedback
  3. Decision (within 2 weeks): Tool is approved, needs revisions, or is not suitable
  4. Documentation (1-2 weeks): If approved, tool page is created
  5. Publication: Tool appears in the catalogue

Rejection Reasons

Tools may not be included if they:

  • Are not relevant to European mobility data
  • Are unmaintained or non-functional
  • Have no documentation
  • Don't meet basic quality standards
  • Duplicate existing tools without clear advantages

Don't worry - we'll provide feedback and suggestions if a tool doesn't initially meet criteria!

Contribution Recognition

We recognize and appreciate all contributors:

  • Tool contributors are credited on tool pages
  • Content contributors are listed in project acknowledgments
  • Community helpers are recognized in our discussions

Other Ways to Contribute

Improve Existing Tool Pages

Found outdated information or want to add more details to a tool page?

  1. Click "Suggest changes to this page" at the bottom of any tool page
  2. Make your edits
  3. Submit a pull request

Report Issues

Found a broken link or incorrect information?

Suggest Improvements

Have ideas for improving the catalogue?

  • Share them in GitHub Discussions
  • Propose new categories
  • Suggest better organization
  • Request new features

Share Feedback

Using a tool from the catalogue? Share your experience!

  • Add comments to tool discussions
  • Share success stories
  • Report issues directly to tool maintainers
  • Help other users in the community

Questions?

Need help or have questions about contributing?

Code of Conduct

We are committed to providing a welcoming and inclusive environment for all contributors. Please:

  • Be respectful and professional
  • Provide constructive feedback
  • Focus on the tools and content, not individuals
  • Help create a positive community

::: tip Quick Start Ready to submit a tool? Start a GitHub Discussion with the "Tool Submission" category! :::

Thank you for helping build the European mobility tools ecosystem! 🚀