diff --git a/content/concepts/contributing.md b/content/concepts/contributing.md index f58ec879..432f4f56 100644 --- a/content/concepts/contributing.md +++ b/content/concepts/contributing.md @@ -33,7 +33,7 @@ Before you start coding right away, please follow those basic guidelines: 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. We follow [Trunk Based Development](https://trunkbaseddevelopment.com) so work in feature branches, branched off from the `main` branch. 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. +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.