From c8efe99ec8d442a323299b0e150966b5b5442450 Mon Sep 17 00:00:00 2001 From: Matthias Kretschmann Date: Thu, 14 Jan 2021 11:27:57 +0100 Subject: [PATCH] extend code contribution instructions --- content/concepts/contributing.md | 34 +++++++++++++++++++++----------- 1 file changed, 23 insertions(+), 11 deletions(-) diff --git a/content/concepts/contributing.md b/content/concepts/contributing.md index f9bcd006..4854ad78 100644 --- a/content/concepts/contributing.md +++ b/content/concepts/contributing.md @@ -3,36 +3,48 @@ title: Ways to Contribute description: Help develop Ocean core software, more --- -### Help develop Ocean core software +## Help develop Ocean core software -We'd love to have you help contribute to the Ocean core software! Here are ways to get going: +We'd love to have you help contribute to the Ocean core software! Before you just start coding, please follow those basic guidelines: -- _Just do it:)_ Branch from the code, improve it, submit a Pull Request. -- Chat with other Ocean developers in [Discord](https://discord.gg/TnXjkR5). -- Because of the weird world of intellectual property, before it can go through, we need to follow the [legal requirements](/concepts/legal-reqs/). Please be aware of this. -- Finally, here's the [Contributor Code of Conduct](/concepts/code-of-conduct/). +- Search existing open and closed issues and PRs if you want to fix a bug or add a new feature to see if something is or has been already reported or worked on. +- Before starting to add features, please open an issue first so it can be discussed. +- Because of the weird world of intellectual property, we need you to follow the [legal requirements](/concepts/legal-reqs/) for contributing code. +- Be excellent to each other, as outlined in our [Contributor Code of Conduct](/concepts/code-of-conduct/). -### Develop an app or integration, using Ocean as a tool +A typical code contribution 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. Work in feature branches, for naming use `feature/your-feature` or `feature/23` for new features and `fix/your-fix` or `fix/23` for bug fixes, referring to the issue number. +3. If you want to get 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 `closes #23` +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. Once a Pull Request is approved, you can merge it. + +Except for GitHub, you can find most Ocean Protocol core developers in [Discord](https://discord.gg/TnXjkR5) if you have further development questions. + +## Develop an app or integration, using Ocean as a tool Integrate Ocean at one of its interface points: React hooks, Javascript library, Python library, smart contracts, etc. Ocean documentation will help. And... you're here:) -### Report a bug +## Report a bug To report a vulnerability, [go here](/concepts/vulnerabilities/). To report a bug that isn't a vulnerability, go to the relevant GitHub repository, click on the Issues tab, click on the New issue button, and read the instructions. -### Improve these docs +## Improve these docs These docs can always be improved. Here's the repo. -### Apply for a developer job +## 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. -### Other ways to get involved +## Other ways to get involved Please go to the [Ocean Community Page](https://www.oceanprotocol.com/community) for more ideas on how to get involved.