Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
67 lines (46 loc) · 3.02 KB

CONTRIBUTING.md

File metadata and controls

67 lines (46 loc) · 3.02 KB

Contribution Guidelines

Thank you for your interest in contributing to FlowSynx!
We’re thrilled to collaborate with developers like you to make this project more powerful, stable, and innovative.

Whether you’re here to:

  • 🐞 Report a bug
  • 💬 Discuss the current state of the project
  • 🔧 Submit a fix
  • 💡 Propose a new feature
  • 🧭 Become a maintainer

We welcome and appreciate your contribution!

Development Workflow

We use GitHub to manage our source code, issues, feature requests, and pull requests.
All changes to the codebase are made through Pull Requests (PRs) — following the principles of GitHub Flow.

How to Contribute Code

  1. Fork the repository and create a new branch from master.
    Use a descriptive branch name, e.g.:
    • feature/workflow-optimization
    • fix/plugin-loader-bug
  2. Implement your changes — write clean, maintainable, and well-documented code.
  3. Write tests for any new or modified functionality.
  4. Update documentation if your changes affect public APIs or usage.
  5. Run all tests and ensure they pass successfully.
  6. Follow coding standards — maintain consistency with the existing style and linting rules.
  7. Submit a Pull Request (PR) including:
    • A clear and concise description of your changes.
    • References to related issues or discussions.
    • Screenshots, logs, or examples where relevant.

💡 We actively review all pull requests and provide constructive feedback. Your ideas and improvements help shape FlowSynx for everyone.

Reporting Bugs & Issues

We use GitHub Issues to track bugs, enhancements, and discussions.

To report a bug, open a new issue and include as much detail as possible:

  • Summary – A short description of the issue.
  • Steps to Reproduce – Include exact steps or a minimal reproducible example (preferably in C#).
  • Expected Behavior – What you expected to happen.
  • Actual Behavior – What actually happens.
  • Additional Context – Logs, screenshots, or environment details that help diagnose the issue.

🔍 Clear, reproducible reports help us resolve issues faster and maintain higher project quality.

Code of Conduct

By participating in this project, you agree to help foster a welcoming and inclusive environment for everyone.
Be respectful, constructive, and considerate in all interactions — collaboration is key to success.

License

By contributing to FlowSynx, you agree that your contributions will be licensed under the terms of the MIT License, which governs this project.

If you have any questions about licensing or contributions, please reach out to the maintainers.

❤️ Thank You

Your time and expertise make FlowSynx better every day.
Together, we can build a flexible, open, and powerful automation platform for everyone.