Skip to content

Commit 7d8b7c9

Browse files
authored
Add CONTRIBUTING.md (#2121)
1 parent b15c864 commit 7d8b7c9

File tree

2 files changed

+34
-3
lines changed

2 files changed

+34
-3
lines changed

CONTRIBUTING.md

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Contributing
2+
3+
We’re glad you found this document that is intended to make contributing to
4+
GitUI as easy as possible!
5+
6+
## Building GitUI
7+
8+
In order to build GitUI on your machine, follow the instructions in the
9+
[“Build” section](./README.md#build).
10+
11+
## Getting help
12+
13+
There’s a [Discord server][discord-server] you can join if you get stuck or
14+
don’t know where to start. People are happy to answer any questions you might
15+
have!
16+
17+
## Getting started
18+
19+
If you are looking for something to work on, but don’t yet know what might be a
20+
good first issue, you can take a look at [issues labelled with
21+
`good-first-issue`][good-first-issues]. They have been selected to not require
22+
too much context so that people not familiar with the codebase yet can still
23+
make a contribution.
24+
25+
[discord-server]: https://discord.gg/rZv4uxSQx3
26+
[good-first-issues]: https://github.com/extrawurst/gitui/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22

README.md

+8-3
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,8 @@
3838
11. [Key Bindings](#bindings)
3939
12. [Sponsoring](#sponsoring)
4040
13. [Inspiration](#inspiration)
41-
14. [Contributors](#contributors)
41+
14. [Contributing](#contributing)
42+
15. [Contributors](#contributors)
4243

4344
## 1. <a name="features"></a> Features <small><sup>[Top ▲](#table-of-contents)</sup></small>
4445

@@ -276,12 +277,16 @@ The key bindings can be customized: See [Key Config](KEY_CONFIG.md) on how to se
276277
- It would be nice to come up with a way to have the map view available in a terminal tool
277278
- [git-brunch](https://github.com/andys8/git-brunch)
278279

279-
## 14. <a name="contributors"></a> Contributors <small><sup>[Top ▲](#table-of-contents)</sup></small>
280+
## 14. <a name="contributing"></a> Contributing <small><sup>[Top ▲](#table-of-contents)</sup></small>
281+
282+
See [CONTRIBUTING.md](CONTRIBUTING.md).
283+
284+
## 15. <a name="contributors"></a> Contributors <small><sup>[Top ▲](#table-of-contents)</sup></small>
280285

281286
Thanks goes to all the contributors that help make GitUI amazing! ❤️
282287

283288
Wanna become a co-maintainer? We are looking for [you](https://github.com/extrawurst/gitui/issues/2084)!
284289

285290
<a href="https://github.com/extrawurst/gitui/graphs/contributors">
286291
<img src="https://contrib.rocks/image?repo=extrawurst/gitui" />
287-
</a>
292+
</a>

0 commit comments

Comments
 (0)