Skip to content

Contributing

KFabrik is an open-source project and welcomes contributions from the community. As the project is in early development, now is a great time to get involved and help shape its direction.

Ways to Contribute

Documentation

  • Improve guides and tutorials
  • Add examples and use cases
  • Fix typos and clarify explanations
  • Translate content

Code (Coming Soon)

Once the software is released, you can contribute: - Features and enhancements - Bug fixes - Integration tests - Performance optimizations

Community

  • Answer questions from other users
  • Share your use cases and feedback
  • Present at meetups or conferences
  • Help with testing and validation

Documentation Guidelines

Writing Style

  • Use clear, concise language
  • Write in present tense
  • Use active voice when possible
  • Keep paragraphs short and focused

Markdown Formatting

  • Use proper heading hierarchy (h1 → h2 → h3)
  • Include code blocks with language identifiers for syntax highlighting
  • Use relative links for internal documentation references
  • Add alt text for images

Code Examples

When the software is available: - Provide complete, working examples - Include expected output - Explain what the code does - Use realistic but simple scenarios

Making Changes

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/your-feature-name)
  3. Make your changes
  4. Test locally with mkdocs serve
  5. Commit with clear, descriptive messages
  6. Submit a pull request

File Organization

  • Place all documentation in the docs/ directory
  • Use lowercase filenames with hyphens (e.g., getting-started.md)
  • Update mkdocs.yml navigation when adding new pages
  • Keep related content together

Pull Request Process

  1. Ensure your changes follow the documentation standards
  2. Update the navigation in mkdocs.yml if adding new pages
  3. Test that all links work correctly
  4. Provide a clear description of your changes
  5. Reference any related issues

Community Resources

Code of Conduct

KFabrik is committed to providing a welcoming and inclusive environment. All contributors are expected to:

  • Be respectful and considerate
  • Welcome newcomers and help them get started
  • Focus on constructive feedback
  • Respect differing viewpoints and experiences

License

By contributing to KFabrik, you agree that your contributions will be licensed under the Apache 2.0 License.

Questions?

If you have questions about contributing, please open an issue on GitHub or reach out through community channels.