Skip to content

Latest commit

 

History

History
115 lines (70 loc) · 5.74 KB

CONTRIBUTING.md

File metadata and controls

115 lines (70 loc) · 5.74 KB
Raw

Contributing to Sismo Hub

Thank you for your interest in improving the Sismo Hub! Your contributions, big or small, are valued and appreciated. This document serves as a guide to help you navigate the contribution process. If you need assistance, feel free to reach out to our #dev-support channel on our Discord community, or on our Builders Telegram group.

Ways to contribute

There are several ways you can contribute to the Sismo Hub:

  • Create new Groups Generators: Creating new Groups Generators is always welcomed! The possibilities for new Groups are endless, as they can be generated from a vast array of open data.

  • Create new Data Providers: By creating new Data Providers, you are supporting developers in effortlessly accessing the data necessary for their own Group Generator creation.

  • Report a bug: If you have discovered a bug in the system, you can open an issue and provide a detailed report. A template for submitting a bug report is available for your convenience.

  • Provide additional context: If you have come across an issue, you can provide additional context, such as screenshots, logs, or code snippets, to help resolve it.

  • Resolve issues: If you have the skills and expertise to resolve an issue, you can demonstrate that the issue is not a problem or open a pull request that implements a fix.

Creating a new Group Generator

Sismo resolves around the concept of Groups of Data Sources. These Groups are generated through the use of a Group Generator.

Check out the existing Group Generators for inspiration!

If you want to start creating you first Group, check out our tutorial here.

You have no idea of Groups to implement but you want to contribute? Check out the GitHub issues we created for the group generators here.

Creating a new Data Provider

Data Providers allow for the querying of data from a range of sources, including APIs, Subgraphs, and on-chain data.

The creation of new Data Providers expands the potential to gather more data for Group generation.

If you want to start creating you first Data Provider, check out our tutorial here.

You have no idea of data providers to implement, but you want to contribute? Check out the GitHub issues we created for the group generators here.

Asking for help

If you need assistance or have any questions, please reach out to our #dev-support channel on our Discord community.

Creating a new issue

Submitting a bug report

When submitting a bug report, please provide a detailed description of the issue and the steps to reproduce it. If possible, include any relevant logs, screenshots, or code snippets to help us understand and resolve the issue.

## Description
A clear and concise description of the bug.

## Steps to Reproduce
1. Step 1
2. Step 2
3. Step 3

## Expected Behavior
What you expected to happen.

## Actual Behavior
What actually happened.

## Screenshots (if applicable)
Attach any relevant screenshots here.

## Additional Information
Node version: [e.g. v18.13.0]
Browser and version: [e.g. Chrome 88.0.4324.96]
Operating system: [e.g. MacOS Monterey ]

Any additional information that may be useful in troubleshooting the issue.

Resolving an issue

If you have the skills and expertise to resolve an issue, you can demonstrate that the issue is not a problem or open a pull request that implements a fix. When submitting a pull request, please include a clear explanation of the problem and your proposed solution.

Submitting a pull request

To help us understand and review your changes, please include the following information in your Pull Request description:

## Context
A brief explanation of the problem or issue you are addressing. This should include any relevant references to related issues or discussions. 

## Changes Made
A detailed explanation of the changes you have made, including any relevant code snippets or screenshots.

## Benefits
How your changes will improve the Sismo platform and solve the problem you're addressing.

## Test Results
The results of any tests you've run to confirm that your changes work as expected.

## Future Considerations
Any additional changes or features you think should be added in the future to enhance the functionality of the Sismo platform.

## Checklist
[] I have tested my changes and confirmed that they work as expected
[] I have updated the relevant documentation, including the Contributor Guide and the README
[] I have added any necessary tests to ensure that my changes are protected from future regressions

Please make sure that you've completed all items in the checklist before submitting your Pull Request.

Code of Conduct

We have a code of conduct in place to ensure a respectful and inclusive environment for all contributors. Please take the time to read and understand the Code of Conduct before making a contribution. Any behavior that violates this code will not be tolerated.


bottom