Skip to content

Add CONTRIBUTING.md #2121

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Mar 24, 2024
Merged

Add CONTRIBUTING.md #2121

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5649efe
Add first sentence to CONTRIBUTING.md
cruessler Mar 10, 2024
8e1f7f3
Extend CONTRIBUTING.md
cruessler Mar 19, 2024
7945868
Put contributors last
cruessler Mar 19, 2024
5f8c1c5
Add link to Discord server
cruessler Mar 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Contributing

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][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.

[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
11 changes: 8 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,8 @@
11. [Key Bindings](#bindings)
12. [Sponsoring](#sponsoring)
13. [Inspiration](#inspiration)
14. [Contributors](#contributors)
14. [Contributing](#contributing)
15. [Contributors](#contributors)

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

Expand Down Expand Up @@ -276,12 +277,16 @@ 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. <a name="contributors"></a> Contributors <small><sup>[Top ▲](#table-of-contents)</sup></small>
## 14. <a name="contributing"></a> Contributing <small><sup>[Top ▲](#table-of-contents)</sup></small>

See [CONTRIBUTING.md](CONTRIBUTING.md).

## 15. <a name="contributors"></a> Contributors <small><sup>[Top ▲](#table-of-contents)</sup></small>

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

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

<a href="https://github.com/extrawurst/gitui/graphs/contributors">
<img src="https://contrib.rocks/image?repo=extrawurst/gitui" />
</a>
</a>
Loading