diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 1b5acf1..c64db89 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -11,23 +11,21 @@ ## Project Goal -> TL;DR -> Applite aims to be simple in every way +> Applite aims to be more of an app store for third-party apps than a full-blown homebrew GUI wrapper. -The goal of Applite is to bring to convenience of Homebrew casks to the average user. It aims to be as simple as possible in every aspect. Easy setup, simple UI that can be understood at a glance, and no technical knowledge required. +The goal of Applite is to bring the convenience of Homebrew casks to the average user. It aims to be as simple as possible in every aspect. Easy setup, simple UI that can be understood at a glance, and no technical knowledge required. Applite has features aimed at more experienced users (e.g. custom brew path and installation directory), but these are not part of the main interface by design. ## If you found a bug -> TL;DL > - Open a new issue > - Describe what the problem is > - Describe the steps you took before it occurred > - Include error messages, logs -> - Provide app version and device information (e.g. Applite: v1.2, MacBook air M2) +> - Provide app version and device information (e.g. Applite: v1.2, MacBook Air M2) -If the problem is related to application actions, e.g. installing, updating or uninstalling. Be sure to check if you can find the error message. When an app encounters an error it should look like this: +If the problem is related to application actions, e.g. installing, updating, or uninstalling. Be sure to check if you can find the error message. When an app encounters an error it should look like this: ![Info button highlighted](https://i.imgur.com/Kik6s8q.jpg) @@ -49,7 +47,7 @@ If the command output is shown as ``, as in the image above, follow [th ## If you want to suggest a feature -- Open a new issue, or a discussion if the feature is more open ended +- Open a new issue, or a discussion if the feature is more open-ended - Describe what you miss and why - Optional: Suggest a solution @@ -57,10 +55,9 @@ Your suggestion is likely to be rejected if it doesn't align with the [project g ## If you want to contribute code ->TL;DR > - If you find a typo or a minor bug, feel free to create a pull request right away > - If you want to do something bigger, let's discuss it first, so you don't waste time on something that won't be accepted. Open a GitHub issue or join the [Official Discord Server](https://discord.gg/ZgB6pRE8Qx). -I'm open to all kind of contributions! +I'm open to all kinds of contributions! This is my first project using Swift and SwiftUI, so the codebase isn't the cleanest. Feel free to contact me if you get lost in the code.