oceanprotocol
/
docs
mirror of https://github.com/oceanprotocol/docs.git
1
0
Fork 0
Code Releases Activity
docs/core-concepts/contributing.md

4.8 KiB
Raw Blame History

title description
Ways to Contribute Help to improve and develop Ocean core software.

Report a bug

To report a bug that isn't a vulnerability, go to the relevant GitHub repository, click on the Issues tab and select Bug report.

Before reporting a bug, search existing open and closed issues and PRs to see if something has already been reported. If not, then go ahead and create a new bug report, following the structure suggested in the issue template.

Report Vulnerabilities

You may be able to earn a bounty for reporting vulnerabilities in sensitive parts of our code. Check our page on Immunify for the latest bug bounties available. You can also responsibly disclose flaws by emailing us at security@oceanprotocol.com.

Suggest a new feature

Use the Issues section of each repository and select Feature request to suggest and discuss any features you would like to see added.

As with bug reports, search existing open and closed issues and PRs to see if something has already been reported.

Fix or improve core software

We'd love to have you contribute to any repository within the oceanprotocol GitHub organization!

Before you start coding right away, please follow those basic guidelines:

  • If no issue for your case is present, open one first before starting to work on something, so it can be discussed.
  • Make yourself familiar with eventual repository-specific contribution requirements and code style requirements.
  • Because of the weird world of intellectual property, we need you to follow the legal requirements for contributing code.
  • Be excellent to each other, as outlined in our Contributor Code of Conduct.

Workflow

A typical code contribution in any Ocean Protocol repository would go as follows:

  1. As an external developer, fork the respective repo and push to your own fork. Ocean core developers push directly on the repo under oceanprotocol org.
  2. You should create a new branch for your changes. The naming convention for branches is: issue-001-short-feature-description. The issue number issue-001 needs to reference the GitHub issue that you are trying to fix. The short feature description helps to quickly distinguish your branch among the other branches in play.
  3. To get visibility and Continuous Integration feedback as early as possible, open your Pull Request as a Draft.
  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 main branch.
  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 is put live automatically.

Except for GitHub, you can find most Ocean Protocol core developers in Discord if you have further development questions.

Develop an app or integration on top of Ocean Protocol

Create an app with one of Ocean Protocol's interface points:

Ocean documentation will help. And... you're here:)

Improve these docs

These docs can always be improved. Every content page has an edit link at its end linking you to the content source on GitHub for simple copy editing.

If you found a technical bug or have an improvement suggestion, head over to the repo's Issues section:

Apply for a developer job

Really love building on Ocean and want to dive deeper? Consider joining us full time. Our openings are listed at https://github.com/oceanprotocol/devjobs.

Get Funding

Funding can be for contributing to the core software, building apps, doing integrations, fixing bugs, community outreach, and more. Checkout our active funding programs for more information:

Other ways to get involved

Please go to the Ocean Community Page for more ideas on how to get involved.