feat: add best practices

Author: zcesur

lib/algora/bot_templates/bot_templates.ex

@@ -12,6 +12,12 @@ defmodule Algora.BotTemplates do
     2. **Submit work**: Create a pull request including `/claim #${ISSUE_NUMBER}` in the PR body to claim the bounty
     3. **Receive payment**: 100% of the bounty is received 2-5 days post-reward. [Make sure you are eligible for payouts](https://algora.io/docs/payments#supported-countries-regions)
 
+    ### ❗ Important guidelines:
+    - To claim a bounty, you need to **provide a short demo video** of your changes in your pull request
+    - If anything is unclear, **ask for clarification** before starting as this will help avoid potential rework
+    - Low quality AI PRs will not receive review and will be closed
+    - Do not ask to be assigned unless you've contributed before
+
     Thank you for contributing to ${REPO_FULL_NAME}!
     ${ATTEMPTS}
     """

lib/algora_web/live/docs_live.ex

@@ -8,7 +8,8 @@ defmodule AlgoraWeb.DocsLive do
         title: "Overview",
         links: [
           %{title: "Introduction", href: "/docs"},
-          %{title: "Slash commands", href: "/docs/commands"}
+          %{title: "Slash commands", href: "/docs/commands"},
+          %{title: "Best practices", href: "/docs/best-practices"}
         ]
       },
       %{

priv/content/docs/best-practices.md

@@ -0,0 +1,26 @@
+---
+title: Best practices
+---
+
+# Best practices
+
+## Issue specs
+
+Good issue specs are the recipe for success.
+
+Explain in detail the desired outcome, any limitations and the acceptance criteria. Include references, examples and mockups where applicable.
+
+- "It should abide by our code styles" is not a requirement and is extremely vague, has no clarity in communication
+- "It should do X, while we don't want Y, we could ignore if it does Z, but definitely shouldn't do K" is the correct approach
+
+Explain technical requirements to work on the issue, ex "Our project requires Mac, with at least this amount of RAM"
+
+## PR review
+
+- Require devs to demonstrate via screenshot/recording that at least X, Y, Z was accomplished to get PR review
+- Close low quality AI PRs without review
+- Do not assign developers without a contribution history
+
+## References
+
+- [Golem Cloud](https://algora.io/golemcloud/home), [Deskflow](https://algora.io/deskflow/home) and [Remotion](https://algora.io/remotion/home) have been praised by developers for writing the best specs