Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
76 lines (53 loc) · 2.58 KB

CONTRIBUTING.md

File metadata and controls

76 lines (53 loc) · 2.58 KB
Raw

Contributing to connect-ios-sdk

We appreciate your interest in contributing to connect-ios-sdk! By contributing, you help improve the project and make it more useful for everyone. This guide will help you get started.

How to Contribute

  1. Fork the repository:

    • Navigate to the connect-ios-sdk repository.
    • Click the "Fork" button at the top-right corner to create your copy of the repository.

  2. Clone your fork:

    • Clone your forked repository to your local machine using the following command:

      git clone https://github.com/gandalf-network/connect-ios-sdk.git

    • Navigate to the cloned directory:

      cd connect-ios-sdk

  3. Create a new branch:

    • Create a new branch for your feature or bug fix:

      git checkout -b feature-name

  4. Make your changes:

    • Make your changes to the codebase.
    • Ensure your code follows the existing style and conventions.
    • Write or update tests as necessary.

  5. Test your changes:

    • Run the tests to ensure your changes don't break the existing code:

      swift test

  6. Commit your changes:

    • Commit your changes with a clear and concise commit message:

      git add .
git commit -m "Description of your changes"

  7. Push to your fork:

    • Push your changes to your forked repository:

      git push origin feature-name

  8. Open a Pull Request:

    • Go to the original repository and click the "New Pull Request" button.
    • Select the branch you just pushed from your fork and compare it with the base repository.
    • Provide a detailed description of your changes and submit the pull request.

Guidelines

  • Coding Standards: Ensure your code adheres to the existing coding standards and conventions.
  • Commit Messages: Write clear and concise commit messages. Use the present tense and be descriptive.
  • Testing: Add or update tests to cover your changes. Ensure all tests pass before submitting your pull request.
  • Documentation: Update documentation as necessary to reflect your changes.

Reporting Issues

If you encounter any issues with the project, please report them using the issue tracker. Provide as much detail as possible to help us understand and resolve the issue.

Thank You

Thank you for contributing to connect-ios-sdk! Your efforts help make this project better for everyone.