Skip to content

Make readme more inviting to contributors #534

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
marko-radosavljevic merged 1 commit into from
Aug 26, 2022
Merged

Make readme more inviting to contributors #534

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 11 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,20 +9,24 @@
[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=Together-Java_TJ-Bot&metric=reliability_rating)](https://sonarcloud.io/dashboard?id=Together-Java_TJ-Bot)
[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=Together-Java_TJ-Bot&metric=security_rating)](https://sonarcloud.io/dashboard?id=Together-Java_TJ-Bot)

TJ-Bot is a Discord Bot used on the [Together Java](https://discord.com/invite/XXFUXzK) server. It is maintained by the community, anyone can contribute.
TJ-Bot is a Discord Bot used on the [Together Java](https://discord.com/invite/XXFUXzK) server. It is maintained by the community, anyone can contribute!

![bot says hello](https://i.imgur.com/FE1MJTV.png)

The idea of this project is to provide learning experience on a real-world project. You will be provided with our guidance at every step of the way, and friendly but thorough reviews!

Feel free to join our [discord server](https://discord.com/invite/XXFUXzK) if you have any questions, or require assistance with the project. :relaxed:

# Getting started

Please read [Contributing](https://github.com/Together-Java/TJ-Bot/wiki/Contributing) if you want to propose ideas and changes or even implement some yourself.
Please read [Contributing](https://github.com/Together-Java/TJ-Bot/wiki/Contributing) guidelines if you are considering helping us out!
There you will find a detailed guide on how to contribute, and plenty of resources in case this is your first time submitting a PR to an open-source project.

Head over to the [Wiki](https://github.com/Together-Java/TJ-Bot/wiki) as general entry point to the project. It provides lots of tutorials, documentation and other information, for example
* creating a discord bot and a private server;
* setting up the project locally;
* adding your own custom commands;
* a technology overview;
* guidance about how to maintain the bot (e.g. VPS, logs, databases, restart).
* creating a discord bot and a private server
* setting up the project locally
* adding your own custom commands
* a technology overview

# Download

Expand Down