Skip to content

Latest commit

 

History

History
84 lines (54 loc) · 3.61 KB

CONTRIBUTING.md

File metadata and controls

84 lines (54 loc) · 3.61 KB

Contributing Guidelines

Welcome to the IO Flow project! We appreciate your interest in contributing. By participating in this project, you agree to abide by the Code of Conduct. This document outlines the guidelines and process for contributing to our project. Please take a moment to review the guidelines before getting started.

Table of Contents

Reporting Issues

If you encounter any issues while using or developing IO Flow, please report them using the issue tracker. Before submitting an issue, please check if a similar issue already exists. Include as much detail as possible, such as the version of IO Flow, steps to reproduce the issue, and relevant logs or error messages.

Making Contributions

We welcome contributions from everyone. To contribute to IO Flow, follow these steps:

  1. Fork the repository to your GitHub account.
  2. Create a new branch for your feature or bug fix: git checkout -b your-branch-name.
  3. Make your changes and ensure they adhere to our coding standards.
  4. Write tests to cover your changes, if applicable.
  5. Commit your changes with a clear and descriptive commit message using our commit guidelines.
  6. Push your branch to your forked repository.
  7. Open a pull request to the main repository's master branch, providing a detailed description of your changes.
  8. Participate in the discussion and address any feedback or suggestions received during the code review process.
  9. Once your pull request is approved, it will be merged into the main repository.

Coding Standards

We strive to maintain a high-quality codebase, and we encourage contributors to follow these coding standards: The codebase is developed mainly by using the airbnb standards.

  • Use clear and descriptive variable and function names.
  • Follow the project's existing code style and formatting conventions.
  • Include inline comments to explain complex logic or important details.
  • Write concise and meaningful documentation where necessary.
  • Ensure your code passes all relevant tests and does not introduce new linting errors.

Commit Guidelines

To keep the commit history clean and organized, we follow the Conventional Commits specification. Please structure your commit messages as follows:

:

[optional body]

[optional footer]

markdown Copy code

The <type> can be one of the following:

  • feat: A new feature or enhancement
  • fix: A bug fix
  • docs: Documentation changes
  • refactor: Code refactoring
  • test: Adding or modifying tests
  • chore: Routine tasks, maintenance, or other non-code changes

The <description> should be a clear and concise summary of the change.

The [optional body] section should provide additional context or details about the change if necessary.

The [optional footer] section should reference any issues or pull requests related to the change.

Submitting Pull Requests

When submitting a pull request, please provide the following information in the description:

  • A summary of the changes made and the problem they solve.
  • Any relevant information that might help with the review process.
  • If applicable, reference any related issues or pull requests.

Code of Conduct

Please review and adhere to our Code of Conduct throughout