Open Source Preparations

[elfenpiff]

Technical Debt

• Write unit tests for event messaging pattern
• remove src/bin/* and old rust_experiments
• namespace/prefix for config files e.g. /tmp/elkodon
• replace all iceoryx´ strings with elkodon`
• follow XDG spec
  • https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html
  • https://www.freedesktop.org/wiki/Software/xdg-user-dirs/
  • set path in pal/settings
• remove platform suffix in pal/settings
• check where &[u8] can be replaced with &str
• tests for discovery
• remove elkodon_bb_posix::SignalHandler from public API and examples, introduce eventloop::wait() instead (maybe with better name)
• final API review before the release in case there are still some quirks left
  • no get_ prefix for getter but a set_ prefix for setter

Cargo.toml

• add version inheritance from root workspace
• Add the following entries:
• every package inherits from main workspace and does not add new dependencies

[workspace.package]
version = ""
repository = ""
homepage = ""
authors = []
edition = "2021"
license = ""
categories = ["ipx"]
description = "elkodon: zero copy ipc"

Changelog

• introduce CHANGELOG.md
• evaluate CI check that every pull request comes with a changelog update

Contributions and Conventions

Write contribution md with the content:

• name conventions for release branch, tags
• branch protection for release branches
• Introduce CONTRIBUTORS.md
• Add pull request template
• Add issue and bug issue template
• elkodon vs Elkodon

Licensing & File Header

• Introduce script to check and modify license header
• Use only spdx license code as header

Documentation

• README.md that contains supported platforms, example, overview
• ROADMAP.md
  • add waitset and quality of life improvements
• CONTRIBUTIONS.md
• documentation for every example
• document whole elkodon crate
• Add badges for CI, Code Coverage, Documentation state, gitter, discord, license, https://linktr.ee/, create Reddit iceoryx room
• Add github labels
• Document feature flags in the README.md, see tracing and log
• Document feature flags in elkodon/lib.rs, see tracing and log

CI Checks

• commit message style elk-##ISSUE_NUMBER##-##BRANCH_NAME##
• every commit is signed
• that linked issue exists
• one approval required
• Documentation contains no warnings
• add ci check that new crate dependencies are only added in the root Cargo.toml and the subcrates inherit from it

CI Platform checks

• Linux x86_64 (archlinux)
• Linux x86_64 (ubuntu-latest)
• Linux aarch64 (archlinux)
• Linux aarch64 (ubuntu-latest)
• Linux x86_64 (rust-nightly)
• FreeBSD
• Windows
• Mac OS

Permanent Issues

• CI updates
• Documentation fixes