Skip to content

Latest commit

 

History

History
133 lines (103 loc) · 4.02 KB

CONTRIBUTING.MD

File metadata and controls

133 lines (103 loc) · 4.02 KB
Raw

Contributing to Fractal

Thank you for considering contributing to Fractal! Contributions are what make the open-source community a wonderful place to learn, inspire, and create. Whether it's fixing a bug, implementing a new feature, improving documentation, or suggesting an enhancement, your help is highly appreciated.

Table of Contents

  1. Code of Conduct
  2. Getting Started
  3. How to Contribute
  4. Development Guidelines
  5. Pull Request Process
  6. Contact

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 [email protected].

Getting Started

To start contributing:

  1. Fork the repository.
  2. Clone your forked repository locally: 
    git clone https://github.com/SkySingh04/fractal.git
  3. Set up the project by installing dependencies: 
    cd fractal
go mod tidy
  4. Create a new branch for your work: 
    git checkout -b feature/<feature-name>

How to Contribute

Bug Reports

If you find a bug:

  • Check existing issues to ensure it hasn't already been reported.
  • Submit a detailed issue, including:
    • Steps to reproduce the bug.
    • Expected vs. actual behavior.
    • Environment details (OS, Go version, etc.).

Feature Requests

If you have an idea for a new feature:

  • Open a feature request on the Issues page.
  • Clearly describe:
    • The problem the feature solves.
    • The proposed solution.

Code Contributions

  1. Find an issue labeled help wanted or good first issue to start.
  2. Comment on the issue to let maintainers know you are working on it.
  3. Follow the development guidelines below to implement the changes.

Development Guidelines

Code Style

  • Follow the Go community’s style guide.
  • Use go fmt to format your code.

Project Structure

The project uses a modular structure:

  • cmd/: Main entry points for CLI and server modes.
  • integrations/: Data source and destination integrations.
  • internal/: Core functionalities like transformations, validations, etc.
  • pkg/: Shared utilities and libraries.
  • config/: YAML-based configuration handling.

Running Tests

Run the test suite before submitting a pull request:

go test ./...

If adding new functionality, include unit tests to verify your changes.

Adding Integrations

To add a new integration (input/output):

  1. Follow the Integration Guide in the main documentation.
  2. Add test cases in the integrations directory.

Pull Request Process

  1. Sync your fork: Ensure your fork is up-to-date with the main repository:

    git fetch upstream
git merge upstream/main

  2. Commit changes: Follow commit message conventions:

    • Use clear and descriptive messages (e.g., fix: resolve data validation issue).
    • Use multiple commits for distinct changes.
    git add .
git commit -m "feat: add RabbitMQ integration"

  3. Push changes:

    git push origin feature/<feature-name>

  4. Create a pull request:

    • Go to the main repository.
    • Navigate to the Pull Requests tab and click "New Pull Request."
    • Select your branch and explain your changes in detail.

  5. Respond to Feedback:

    • Be prepared to revise your code based on maintainers' feedback.

Contact

For any questions, feel free to reach out:

  • Open an issue for general queries or bug reports.

Thank you for contributing to Fractal! Together, we can build a powerful and flexible data processing tool. 🎉