From 5649efe69b1a2d908a328d3913747d5857558520 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Christoph=20R=C3=BC=C3=9Fler?= Date: Sun, 10 Mar 2024 19:10:27 +0100 Subject: [PATCH 1/4] Add first sentence to CONTRIBUTING.md --- CONTRIBUTING.md | 4 ++++ README.md | 7 ++++++- 2 files changed, 10 insertions(+), 1 deletion(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000000..44fe27bc7d --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,4 @@ +# Contributing + +We’re glad you found this document that is intended to make contributing to +GitUI as easy as possible! diff --git a/README.md b/README.md index c208a6f778..e605004c3a 100644 --- a/README.md +++ b/README.md @@ -39,6 +39,7 @@ 12. [Sponsoring](#sponsoring) 13. [Inspiration](#inspiration) 14. [Contributors](#contributors) +15. [Contributing](#contributing) ## 1. Features [Top ▲](#table-of-contents) @@ -284,4 +285,8 @@ Wanna become a co-maintainer? We are looking for [you](https://github.com/extraw - \ No newline at end of file + + +## 15. Contributing [Top ▲](#table-of-contents) + +See [CONTRIBUTING.md](CONTRIBUTING.md). From 8e1f7f3140901ce11864d27a41178e8228a4703f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Christoph=20R=C3=BC=C3=9Fler?= Date: Tue, 19 Mar 2024 19:39:48 +0100 Subject: [PATCH 2/4] Extend CONTRIBUTING.md --- CONTRIBUTING.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 44fe27bc7d..ebae2302fd 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,3 +2,23 @@ We’re glad you found this document that is intended to make contributing to GitUI as easy as possible! + +## Building GitUI + +In order to build GitUI on your machine, follow the instructions in the +[“Build” section](./README.md#build). + +## Getting help + +There’s a Discord server you can join if you get stuck or don’t know where to +start. People are happy to answer any questions you might have! + +## Getting started + +If you are looking for something to work on, but don’t yet know what might be a +good first issue, you can take a look at [issues labelled with +`good-first-issue`][good-first-issues]. They have been selected to not require +too much context so that people not familiar with the codebase yet can still +make a contribution. + +[good-first-issues]: https://github.com/extrawurst/gitui/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22 From 79458684edc60d19e90074a382856dcbc0e86b4a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Christoph=20R=C3=BC=C3=9Fler?= Date: Tue, 19 Mar 2024 19:42:05 +0100 Subject: [PATCH 3/4] Put contributors last --- README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index e605004c3a..c0761baeb0 100644 --- a/README.md +++ b/README.md @@ -38,8 +38,8 @@ 11. [Key Bindings](#bindings) 12. [Sponsoring](#sponsoring) 13. [Inspiration](#inspiration) -14. [Contributors](#contributors) -15. [Contributing](#contributing) +14. [Contributing](#contributing) +15. [Contributors](#contributors) ## 1. Features [Top ▲](#table-of-contents) @@ -277,7 +277,11 @@ The key bindings can be customized: See [Key Config](KEY_CONFIG.md) on how to se - It would be nice to come up with a way to have the map view available in a terminal tool - [git-brunch](https://github.com/andys8/git-brunch) -## 14. Contributors [Top ▲](#table-of-contents) +## 14. Contributing [Top ▲](#table-of-contents) + +See [CONTRIBUTING.md](CONTRIBUTING.md). + +## 15. Contributors [Top ▲](#table-of-contents) Thanks goes to all the contributors that help make GitUI amazing! ❤️ @@ -286,7 +290,3 @@ Wanna become a co-maintainer? We are looking for [you](https://github.com/extraw - -## 15. Contributing [Top ▲](#table-of-contents) - -See [CONTRIBUTING.md](CONTRIBUTING.md). From 5f8c1c552806b3a463de6529d4696fabd316fe40 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Christoph=20R=C3=BC=C3=9Fler?= Date: Sun, 24 Mar 2024 16:29:25 +0100 Subject: [PATCH 4/4] Add link to Discord server --- CONTRIBUTING.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ebae2302fd..1f5bf30567 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -10,8 +10,9 @@ In order to build GitUI on your machine, follow the instructions in the ## Getting help -There’s a Discord server you can join if you get stuck or don’t know where to -start. People are happy to answer any questions you might have! +There’s a [Discord server][discord-server] you can join if you get stuck or +don’t know where to start. People are happy to answer any questions you might +have! ## Getting started @@ -21,4 +22,5 @@ good first issue, you can take a look at [issues labelled with too much context so that people not familiar with the codebase yet can still make a contribution. +[discord-server]: https://discord.gg/rZv4uxSQx3 [good-first-issues]: https://github.com/extrawurst/gitui/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22