Ways to contribute#
Choose the contribution that helps your team and other Eufemia users. You can report an issue, improve documentation, suggest a feature, add examples, or submit code.
Start a contribution#
- Report an issue or make your first contribution.
- Reproduce a bug with a small example.
- Follow the local development workflow to change code or documentation.
- Read the development principles before introducing new dependencies or APIs.
Contribution guidelines#
- Code guide: How to write consistent source code - clean code principles, code formatting for JavaScript/TypeScript/SCSS.
- Documentation: How to write documentation and what to include.
- Issues: Template for reporting issues and suggesting new features.
- Git commits: How to make commit messages, submit PRs, and other Git conventions.
- Naming: A list of naming conventions for all languages and variable types.
- Theming: How to maintain and create a theme.
Release and maintenance#
- Follow the release process, including icons and design tokens.
- Check troubleshooting and FAQ for local setup and test issues.
- Preview documentation images and suggest a documentation change.
Community and resources#
Ask questions in #eufemia-web, contact the team, or browse the GitHub repository.
Read the brand guidelines and the license when contributing. Eufemia is a living design system, improved by its contributors.