Help develop Ocean Protocol software like a superhero
Do you think you see a bug in our code? To report a bug that isn't a vulnerability, go to the relevant GitHub repository, click on the Issues tab, and select Bug Report.
First, make sure that you search existing open + closed issues + PRs to see if your bug has already been reported there. If not, then go ahead and create a new bug report! 🦸
Follow our steps below to properly document your bug! Paste the screenshots into your GitHub issue.
Did you find a glitch in our code matrix?
Use the Issues section of each repository and select
Feature requestto suggest and discuss any features you would like to see added.
As with bug reports, don't forget to search existing open + closed issues + PRs to see if something has already been suggested.
Before you start coding, please follow these basic guidelines:
- If no feature request issue for your case is present, please open one first before starting to work on something, so it can be discussed openly with Ocean core team.
- Make yourself familiar with the repository-specific contribution requirements and code style requirements.
- 1.As an external developer, fork the respective repo and push your code changes to your own fork. Ocean core developers push directly on the repo under
- 2.Provide the issue # information when you open a PR, for example:
issue-001-short-feature-description. The issue number
issue-001needs to reference the GitHub issue that you are trying to fix. The short feature description helps us to quickly distinguish your PR among the other PRs in play.
- 3.To get visibility and Continuous Integration feedback as early as possible, open your Pull Request as a
- 4.Give it a meaningful title, and at least link to the respective issue in the Pull Request description, like
Fixes #23. Describe your changes, mention things for reviewers to look out for, and for UI changes screenshots and videos are helpful.
- 5.Once your Pull Request is ready, mark it as
Ready for Review, in most repositories code owners are automatically notified and asked for review.
- 6.Get all CI checks green and address eventual change requests.
- 7.If your PR stays open for longer and merge conflicts are detected, merge or rebase your branch against the current
- 8.Once a Pull Request is approved, you can merge it.
Depending on the release management of each repository, your contribution will be either included in a next release, or deployed live automatically.
We LOVE builders of dApps on Ocean! Nothing makes us feel prouder than seeing you create awesome things with our open-source tools.