From c13aa50094c34af98d1cd26872f193359faa95bb Mon Sep 17 00:00:00 2001 From: Andrew Lee Date: Fri, 27 Sep 2024 13:03:40 -0400 Subject: Added the contributing document --- CONTRIBUTING.md | 11 +++++++++++ README.md | 2 +- 2 files changed, 12 insertions(+), 1 deletion(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..bfcf47b --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,11 @@ +# How to contribute + +When contributing to DLAP, it must follow both the Code of Conduct, and the GPL 3.0 License. + +For communication, you can join [Alee's Discord server](https://discord.gg/EFhRDqG) as it is the main place to communicate. + +# Pushing changes +You **MUST** use the `testing` branch to make changes, as it is also used for translations that will be pulled to the `stable` branch. + +# Coding conventions +As of right now, there are no coding conventions (unless that will change in the future). diff --git a/README.md b/README.md index b052cc7..080f6da 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ DLAP is a Discord bot that lets you play local audio tracks in your server. With [Translate](https://parlance.vicr123.com/projects/dlap) | [Video Tutorial](https://youtu.be/Gvva8LHjOOo) | [Support Server](https://discord.gg/EFhRDqG) -If you want to add a feature or there's anything wrong, feel free to make a fork and put a pull request. +If you want to add a feature or there's anything wrong, read the [CONTRIBUTING](https://github.com/Alee14/DLAP/blob/stable/CONTRIBUTING.md) document, then feel free to make a fork and put a pull request. ## Looking for Maintainers As you know, I may not keep up the project at times, or I could possibly introduce more bugs in this project. -- cgit v1.2.3