Public Repo - https://github.com/distroinfinity/superflow

Contribution Guide

Thank you for your interest in contributing to our project! Contributions from the community are crucial to improving and expanding this project. This guide will help you get started.

We ask contributors to request to get an issue assigned to prevent several people from working on the same issue at the same time and getting frustrated.

How to Contribute to Superflow

1. Fork the Repository

   • Create a fork of the repository on your GitHub account.

   • Add the original repository as an upstream remote to keep your fork updated:

     bash
     CopyEdit
     git remote add upstream <https://github.com/><original-owner>/superflow.git
     

2. Clone Your Fork

   • Clone your fork to your local machine:

     bash
     CopyEdit
     git clone <https://github.com/><your-username>/superflow.git
     

3. Create a Topic Branch

   • Create a new branch for your changes and give it an appropriate name.

   • Tip: Prefix the branch name with the issue number for clarity (e.g., 2374-fix-liquidity-script):

     bash
     CopyEdit
     git checkout -b <branch-name>
     

4. Make Your Changes

   • Follow the coding conventions of the repository.
   • Ensure each commit serves a single purpose and is easy to understand.
   • Avoid mixing formatting fixes or refactoring with functional changes in a single commit.

5. Write Meaningful Commit Messages

   • Follow best practices for commit messages. For guidance, see How to Write a Git Commit Message.

6. Test Your Changes Locally

   • Ensure your changes do not break any existing functionality.
   • Add unit and end-to-end tests for your changes.
   • Test thoroughly before submitting a PR.

7. Update Documentation

   • If your changes introduce new functionality or modify existing behavior, update relevant documentation.
   • Include code examples, usage instructions, or configuration changes as needed.

8. Push Your Changes

   • Push your branch to your forked repository:

     bash
     CopyEdit
     git push origin <branch-name>
     
     

9. Create a Pull Request (PR)

   • Go to the original repository and click on "New Pull Request."
   • Include a descriptive title with the issue number in square brackets (e.g., [#2374] Fix liquidity script bug).
   • Write a detailed description of the problem addressed, the changes made, dependencies, and any backward-incompatible changes.

10. Label Your PR

    • Add labels to categorize your PR (e.g., "bug," "enhancement," or "documentation").

11. Link to Relevant Issues

    • If your PR addresses an existing issue, link it by commenting on the issue with the PR number.