From 2989710785a0ed30833330163c920f0b1f1e54c6 Mon Sep 17 00:00:00 2001 From: Keith Stevens Date: Wed, 28 Dec 2022 17:03:24 +0900 Subject: [PATCH 1/3] Enhancing the readme with some coordination suggestions --- README.md | 37 +++++++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) diff --git a/README.md b/README.md index a2b92789..816fc0e8 100644 --- a/README.md +++ b/README.md @@ -30,6 +30,43 @@ All open source projects begins with people like you. Open source is the belief [Visit the Notion](https://ykilcher.com/open-assistant) +### Taking on Tasks + +We have a growing task list +[of issues](https://github.com/LAION-AI/Open-Assistant/issues). Find an issue +that appeals to you and make a comment that you'd like to work on it. Include +in your comment a brief description of how you'll solve the problem and if +there are any open questions you want to discuss. Once a project coordinator +has assigned the issue to you, start working on it. + +If the issue is currently unclear but you are interested, please post in +Discord and someone can help clarify the issue with more detail. + +### Submitting Work + +We're all working on different parts of Open Assistant together. To make +contributions smoothly we recommend the following: + +1. Work on a small focused change that only touches on a few files. +1. Run `pre-commit` and make sure all files have formatting fixed. This + simplifies life for reviewers. +1. Package up a small bit of work that solves part of the problem into a Pull + Request and send it out for review +1. If you're lucky, we can merge your change into `main` without any problems. + If there's changes to files you're working on, resolve them by: +1. First try rebase as suggested + [in these instructions](https://timwise.co.uk/2019/10/14/merge-vs-rebase/#should-you-rebase) +1. If rebase feels too painful, merge as suggested + [in these instructions](https://timwise.co.uk/2019/10/14/merge-vs-rebase/#should-you-merge) +1. Once you've resolved any conflicts, finish the review and merge into `main`. +1. Merge in your change and move onto a new issue or the second step of your + current issue. + +Additionally, if someone is working on an issue that interests you, ask if they +need help on it or would like suggestions on how to approach the issue. If so, +share wildly. If they seem to have a good handle on it, let them work on their +solution until a challenge comes up. + ## Developer Setup Work is organized in the [project board](https://github.com/orgs/LAION-AI/projects/3). From 7c2c0ec17bb9ccca594f946880a3103a102f17ab Mon Sep 17 00:00:00 2001 From: Keith Stevens Date: Wed, 28 Dec 2022 19:44:22 +0900 Subject: [PATCH 2/3] Adding a section about reviews --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 816fc0e8..3cd98c9a 100644 --- a/README.md +++ b/README.md @@ -67,6 +67,13 @@ need help on it or would like suggestions on how to approach the issue. If so, share wildly. If they seem to have a good handle on it, let them work on their solution until a challenge comes up. +### When does a review finish + +A review finishes when all blocking comments are addressed and at least one +owning reviewer has approved the PR. Be sure to acknowledge any non-blocking +comments either by making the request change, explaining why it's not being +addressed now, or filling an issue to handle it later. + ## Developer Setup Work is organized in the [project board](https://github.com/orgs/LAION-AI/projects/3). From a218a2eae641eff04c55a20ef9bb5081f465d233 Mon Sep 17 00:00:00 2001 From: Yannic Kilcher Date: Wed, 28 Dec 2022 13:45:40 +0100 Subject: [PATCH 3/3] typo fix --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 3cd98c9a..0cff83b2 100644 --- a/README.md +++ b/README.md @@ -72,7 +72,7 @@ solution until a challenge comes up. A review finishes when all blocking comments are addressed and at least one owning reviewer has approved the PR. Be sure to acknowledge any non-blocking comments either by making the request change, explaining why it's not being -addressed now, or filling an issue to handle it later. +addressed now, or filing an issue to handle it later. ## Developer Setup