From 7d35cb08ddc7da3ac7556ae54776152e4e210d2d Mon Sep 17 00:00:00 2001 From: Jeffry Samuel <69224322+Jeffser@users.noreply.github.com> Date: Sun, 11 Aug 2024 00:32:55 -0600 Subject: [PATCH] Create CONTRIBUTING.md --- CONTRIBUTING.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..f1a74c2 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,30 @@ +# Contributing Rules + +## Translations + +If you want to translate or contribute on existing translations please read [this discussion](https://github.com/Jeffser/Alpaca/discussions/153). + +## Code + +1) Before contributing code make sure there's an open [issue](https://github.com/Jeffser/Alpaca/issues) for that particular problem or feature. +2) Ask to contribute on the responses to the issue. +3) Wait for [my](https://github.com/Jeffser) approval, I might have already started working on that issue. +4) Test your code before submitting a pull request. + +## Q&A + +### Do I need to comment my code? + +There's no need to add comments if the code is easy to read by itself. + +### What if I need help or I don't understand the existing code? + +You can reach out on the issue, I'll try to answer as soon as possible. + +### What IDE should I use? + +I use Gnome Builder but you can use whatever you want. + +### Can I be credited? + +You might be credited on the GitHub repository in the [thanks](https://github.com/Jeffser/Alpaca/blob/main/README.md#thanks) section of the README.