CONTRIBUTING.md

CONTRIBUTING.md

Contributing to Ideal Flow Network

First off, thank you for considering contributing to the Ideal Flow Network project! Your contributions help improve the project for everyone.

Table of Contents

• Contributing to Ideal Flow Network
  • Table of Contents
  • Code of Conduct
  • How Can I Contribute?
    • Reporting Bugs
    • Suggesting Enhancements
    • Contributing Code
    • Improving Documentation
  • Pull Request Process
  • Community
  • Credits

Code of Conduct

This project adheres to the Contributor Covenant Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to kardi.teknomo@petra.ac.id.

How Can I Contribute?

Reporting Bugs

If you find a bug, please report it by opening an issue on GitHub.

• Check Existing Issues: Before reporting, please check if the issue has already been reported.
• Create a New Issue: If it hasn't, create a new issue and provide detailed information.
  • Title: A clear and descriptive title.
  • Description: Describe the steps to reproduce the bug, the expected result, and the actual result.
  • Environment: Include information about your environment (Python version, OS, etc.).

Suggesting Enhancements

If you have ideas for new features or improvements, we'd love to hear them!

• Open a Feature Request: Create a new issue labeled as enhancement.
• Provide Details: Explain the enhancement and why it would be useful.

Contributing Code

We welcome code contributions! We encourage you create your own plugin and example on how to do automate using Ideal Flow Network.

• Find an Issue: Look for issues labeled as help wanted or good first issue.
• Fork the Repository: Create a personal fork of the repository.
• Create a Feature Branch: Use a descriptive name (e.g., feature/add-new-algorithm).
• Commit Changes: Make atomic commits with clear messages.
• Push to Your Fork: Push your changes to your forked repository.
• Submit a Pull Request: Open a pull request to the main branch.

Improving Documentation

Good documentation helps everyone.

• Fix Typos or Errors: Feel free to correct any mistakes you find.
• Add Examples: Contribute code examples or tutorials.
• Update Existing Content: Enhance explanations for clarity.

Pull Request Process

1. Ensure Code Quality: Your code should be well-formatted and follow the project's coding standards.
2. Write Tests: If applicable, add tests for your changes.
3. Update Documentation: Reflect any changes in the documentation.
4. Submit Pull Request: Provide a clear description of your changes.
5. Address Feedback: Be responsive to any review comments.

Community

• Join the Discussion: Participate in our discord.
• Stay Updated: Follow us on Twitter or Telegram channel.

Credits

Significant contributors will be acknowledged in the project's documentation and release notes. Thank you for helping make this project better!