Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
74 lines (52 loc) · 2.43 KB

CONTRIBUTING.md

File metadata and controls

74 lines (52 loc) · 2.43 KB

Contributing to the 5-Step Algorithm Skill

🌐 Language / Sprache: English | Deutsch

Thank you for your interest in contributing to this project!

How You Can Contribute

Reporting Issues

If you find a bug or have a suggestion:

  1. Check whether the issue already exists in the Issues section
  2. If not, create a new issue with a clear title and description
  3. Include examples of the problematic behavior, if applicable
  4. Tag the issue appropriately (Bug, Enhancement, Question, etc.)

Submitting Changes

  1. Fork the repository to your own GitHub account
  2. Create a new branch for your feature or bug fix: 
    git checkout -b feature/your-feature-name
  3. Make your changes with clear, descriptive commit messages
  4. Test your changes thoroughly
  5. Submit a Pull Request with:
    • Clear description of what you changed and why
    • Reference to related issues
    • Examples of the improvement, if applicable

Areas for Contributions

We are particularly interested in contributions in these areas:

  • Domain-specific adaptations (e.g., for healthcare, finance, NGOs, or specific industries)
  • Multilingual support (translations, cultural adaptations)
  • Worked examples with complete process analyses from different sectors
  • Evaluation metrics for measuring optimization quality
  • Integration guides for different platforms
  • Documentation improvements

Guidelines

  • Follow the existing code style and documentation format
  • Keep changes focused and atomic
  • Write clear commit messages
  • Update documentation according to your changes
  • Be respectful and constructive in discussions
  • When adding German content, use Swiss German spelling (no ß)

Questions?

If you have questions about contributing, don't hesitate to:

  • Open a Discussion
  • Reach out via Issues
  • Check the existing documentation first

Code of Conduct

We are committed to creating a welcoming and inclusive environment. Please:

  • Be respectful and considerate
  • Welcome newcomers and help them get started
  • Focus on what's best for the community
  • Show empathy towards other contributors

License

By contributing, you agree that your contributions will be licensed under the MIT License.

Thank you for helping improve this skill! 🙏