Skip to content

Latest commit

 

History

History
90 lines (57 loc) · 3.06 KB

CONTRIBUTING.md

File metadata and controls

90 lines (57 loc) · 3.06 KB
Raw

Contributing to dApp SDK

Thank you for your interest in contributing to the dApp SDK! We appreciate the efforts of our community members and welcome contributions to improve and enhance the SDK. This document outlines the contribution process and provides guidelines for making your contributions as smooth as possible.

Code of Conduct

By participating in this project, you agree to abide by our Code of Conduct. Please ensure that your contributions and interactions with the community follow the guidelines outlined in the Code of Conduct.

Getting Started

If you're contributing to this repo, you are a Development Partner. i.e. You are from a projects that want to build open-source features (Payments, Messaging, Recommendations, Analytics) for dApp Store Kit.

At a high level, you're expected to do following

  1. Add code example for your project in the examples directory.
  2. Add relevant documentation for your project in the docs directory.
  3. Update the availability of your project in the frameworks at docs/README.md file.

The detailed steps to do so are following:

  1. Fork the repository: To start contributing, fork the dApp SDK repository to your own GitHub account.

  2. Clone your fork: Clone your fork to your local machine:

git clone https://github.com/<your-username>/dapp-sdk.git
  1. Create a new branch: Create a new branch for your feature or bugfix:
git checkout -b my-feature-branch

  1. Make your changes: Implement your feature or bugfix, ensuring that you follow the coding standards and best practices.

  2. Commit your changes: Commit your changes to the new branch:

git add .
git commit -m "Add my feature"
  1. Keep your fork up-to-date: Sync your fork with the upstream repository to ensure your changes can be easily merged:
git remote add upstream https://github.com/merokudao/dapp-sdk.git
git fetch upstream
git merge upstream/main
  1. Push your changes: Push your changes to your fork:
git push origin my-feature-branch
  1. Create a pull request: Create a pull request from your fork to the main dApp SDK repository, providing a clear and concise description of your changes.

Pull Request Guidelines

Ensure that your pull request includes a clear and detailed description of the changes you have made. If your pull request addresses an existing issue, please reference the issue number in your description. Add relevant labels to your pull request, such as feature, bugfix, documentation, etc. Make sure your code follows the project's coding standards and best practices. Include tests for your changes, if applicable. Update the documentation as necessary.

Review Process

Once your pull request has been submitted, it will be reviewed by the dApp SDK maintainers. During the review process, the maintainers may provide feedback and request changes to your code. Please be patient and address any feedback or requested changes as soon as possible to ensure a smooth and timely review process.