Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
241 lines (188 loc) · 6.56 KB

CONTRIBUTING.md

File metadata and controls

241 lines (188 loc) · 6.56 KB

Contributing to RequestFlow

Thank you for your interest in contributing to RequestFlow! This document provides guidelines and instructions for contributing to the project.

Table of Contents

Code of Conduct

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

Getting Started

  1. Fork the repository on GitHub
  2. Clone your fork locally: 
    git clone https://github.com/YOUR-USERNAME/RequestFlow.git
cd RequestFlow
  3. Add upstream remote: 
    git remote add upstream https://github.com/fatehmtd/RequestFlow.git

Development Setup

Prerequisites

  • Qt 6.7.3+ (with SVG and OpenGL modules)
  • C++17 compatible compiler:
    • Windows: MinGW 9.0+
    • Linux: GCC 11+
    • macOS: Clang (Xcode Command Line Tools)
  • Git

Building the Project

Windows (MinGW)

cd RequestFlowApp
mkdir build
cd build
qmake ..\RequestFlowApp.pro -r "CONFIG+=release"
mingw32-make -j $env:NUMBER_OF_PROCESSORS

Linux

# Install dependencies (Ubuntu/Debian)
sudo apt-get install qt6-base-dev qt6-svg-dev qt6-declarative-dev \
    libgl1-mesa-dev libxkbcommon-dev

cd RequestFlowApp
mkdir -p build && cd build
qmake6 ../RequestFlowApp.pro -r "CONFIG+=release"
make -j$(nproc)

macOS

# Install Qt via Homebrew or Qt installer
brew install qt@6

cd RequestFlowApp
mkdir -p build && cd build
qmake ../RequestFlowApp.pro -r "CONFIG+=release"
make -j$(sysctl -n hw.ncpu)

Project Structure

RequestFlowApp/
├── CoreModel/          # Core data models and business logic
│   ├── model/          # Data structures (Graph, Node, Slot, etc.)
│   └── ...
├── CoreView/           # UI components and visual elements
│   ├── view/           # Node widgets, scene graph, connections
│   ├── nodes/          # SVG icons for nodes
│   └── ...
├── ExecutionEngine/    # HTTP request execution and workflow processing
└── RequestFlow/        # Main application
    ├── icons/          # Application icons
    └── ...

How to Contribute

Types of Contributions

We welcome various types of contributions:

  • Bug Fixes: Fix issues reported in the issue tracker
  • New Features: Implement new node types, functionality, or tools
  • Documentation: Improve README, code comments, or create tutorials
  • UI/UX: Enhance the user interface and user experience
  • Testing: Add unit tests or integration tests
  • Performance: Optimize code for better performance
  • Platform Support: Improve cross-platform compatibility

Contribution Workflow

  1. Check existing issues or create a new one to discuss your contribution
  2. Create a feature branch: 
    git checkout -b feature/your-feature-name
  3. Make your changes with clear, focused commits
  4. Test your changes thoroughly
  5. Push to your fork: 
    git push origin feature/your-feature-name
  6. Submit a Pull Request from your fork to the main repository

Coding Standards

C++ Guidelines

  • Use C++17 features where appropriate
  • Follow the existing code style and formatting
  • Use meaningful variable and function names
  • Add comments for complex logic
  • Prefer const correctness
  • Use smart pointers (std::unique_ptr, std::shared_ptr) for memory management

Qt Specific

  • Follow Qt naming conventions (camelCase for methods, _underscore prefix for private members)
  • Use Qt's signal/slot mechanism for event handling
  • Properly manage Qt object ownership and parent-child relationships
  • Use Q_OBJECT macro for classes that need signals/slots

Code Organization

  • Keep classes focused on a single responsibility
  • Separate UI logic from business logic
  • Use header files (.h) for declarations and source files (.cpp) for implementations
  • Include guards or #pragma once in headers

Example Code Style

class CustomNode : public Node
{
    Q_OBJECT
public:
    CustomNode(Graph* parent);
    ~CustomNode();
    
    void setValue(const QString& value);
    QString getValue() const;

signals:
    void valueChanged(const QString& value);

private:
    void updateInternalState();
    
    QString _value;
    int _counter;
};

Pull Request Process

  1. Update documentation if you're changing functionality

  2. Ensure the code builds on your platform without warnings

  3. Test your changes - manually test the affected features

  4. CI checks must pass - All pull requests run automated builds on:

    • Linux (Ubuntu 22.04)
    • macOS (latest)
    • Windows (latest)

    PRs cannot be merged until all CI checks pass.

  5. Write a clear PR description:

    • What does this PR do?
    • Why is this change needed?
    • How has it been tested?
    • Screenshots (if UI changes)

  6. Link related issues using keywords like "Fixes #123"

  7. Be responsive to review feedback

PR Title Format

Use clear, descriptive titles:

  • Fix: Crash when deleting connected nodes
  • Feature: Add REST authentication node
  • Docs: Update build instructions for macOS
  • Refactor: Simplify message passing logic

Reporting Bugs

When reporting bugs, please include:

  1. Description: Clear description of the bug
  2. Steps to Reproduce: Detailed steps to recreate the issue
  3. Expected Behavior: What should happen
  4. Actual Behavior: What actually happens
  5. Environment:
    • OS and version
    • Qt version
    • RequestFlow version
    • Compiler used
  6. Screenshots/Logs: If applicable
  7. Possible Fix: If you have ideas (optional)

Suggesting Enhancements

We welcome feature suggestions! Please provide:

  1. Use Case: Why is this feature needed?
  2. Proposed Solution: How should it work?
  3. Alternatives: Other approaches you've considered
  4. Additional Context: Screenshots, mockups, or examples

Questions?

If you have questions about contributing:

Recognition

Contributors will be recognized in:

  • GitHub contributors list
  • Release notes
  • Project documentation (for significant contributions)

Thank you for helping make RequestFlow better!