From c4e2e75404975ba54f2080d7054978b0f23c5b51 Mon Sep 17 00:00:00 2001 From: kiritowu Date: Fri, 30 Dec 2022 11:57:30 +0800 Subject: [PATCH 1/3] Update README to include github collaboration guide --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f6672a2a..589c9671 100644 --- a/README.md +++ b/README.md @@ -66,11 +66,13 @@ Discord and someone can help clarify the issue with more detail. We're all working on different parts of Open Assistant together. To make contributions smoothly we recommend the following: +1. [Fork this project repository](https://docs.github.com/en/get-started/quickstart/fork-a-repo) and clone it to your local machine (Read more [About Forks](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks)). +1. Before working on any changes, try to [sync the forked repository](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/syncing-a-fork) to keep it up-to-date with the upstream repository. 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. Package up a small bit of work that solves part of the problem [into a Pull + Request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork) 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 From 99bfa02ebafef88ad0222f856aae35a254aec3db Mon Sep 17 00:00:00 2001 From: kiritowu Date: Fri, 30 Dec 2022 12:05:55 +0800 Subject: [PATCH 2/3] Break instructions to multiple lines for improved readibility --- README.md | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 589c9671..4b680b6f 100644 --- a/README.md +++ b/README.md @@ -66,13 +66,18 @@ Discord and someone can help clarify the issue with more detail. We're all working on different parts of Open Assistant together. To make contributions smoothly we recommend the following: -1. [Fork this project repository](https://docs.github.com/en/get-started/quickstart/fork-a-repo) and clone it to your local machine (Read more [About Forks](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks)). -1. Before working on any changes, try to [sync the forked repository](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/syncing-a-fork) to keep it up-to-date with the upstream repository. +1. [Fork this project repository](https://docs.github.com/en/get-started/quickstart/fork-a-repo) + and clone it to your local machine. + (Read more [About Forks](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks)). +1. Before working on any changes, try to + [sync the forked repository](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/syncing-a-fork) + to keep it up-to-date with the upstream repository. 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](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork) and send it out for review +1. Package up a small bit of work that solves part of the problem + [into a Pull Request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork) + and [send it out for review](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/requesting-a-pull-request-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 From fd33a8b6c730614ee3d8550d648a8e42ab436f67 Mon Sep 17 00:00:00 2001 From: kiritowu Date: Fri, 30 Dec 2022 12:08:31 +0800 Subject: [PATCH 3/3] Ensure consistency for the use of full stop in README/Submitting Work --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 4b680b6f..8dbdff86 100644 --- a/README.md +++ b/README.md @@ -68,7 +68,7 @@ contributions smoothly we recommend the following: 1. [Fork this project repository](https://docs.github.com/en/get-started/quickstart/fork-a-repo) and clone it to your local machine. - (Read more [About Forks](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks)). + (Read more [About Forks](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks)) 1. Before working on any changes, try to [sync the forked repository](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/syncing-a-fork) to keep it up-to-date with the upstream repository. @@ -81,9 +81,9 @@ contributions smoothly we recommend the following: 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) + [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) + [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.