Browse Source

Start adding Contributor documentation

JornosDekstop 2 years ago
parent
commit
abba35327b
4 changed files with 47 additions and 0 deletions
  1. 4 0
      en/contributors/toc.md
  2. 32 0
      en/contributors/ways-to-contribute.md
  3. 9 0
      en/index.md
  4. 2 0
      en/toc.yml

+ 4 - 0
en/contributors/toc.md

@@ -0,0 +1,4 @@
+# [Ways to contribute](ways-to-contribute.md)
+## [Contributing to the engine](engine/contribute-engine.md)
+## [Contributing to documentation](contribute-documentation.md)
+## [Contributing to the website](contribute-website.md)

+ 32 - 0
en/contributors/ways-to-contribute.md

@@ -0,0 +1,32 @@
+# Ways to contribute
+Stride 3d is a non-profit, community-driven free and open source project.
+There are no full-time developers dedicated solely to Stride's advancement; instead, the engine progresses through the voluntary contributions of both the core team and the broader community.
+
+In order to thrive, Stride requires the help from other community members. There are various ways you can help:
+
+### Community activity
+To make Stride3d better, just use it and tell others about it in your blogs, videos, and events. Get involved in discussions on [Discord](https://discord.gg/f6aerfE) and [Github Discussion](https://github.com/stride3d/stride/discussions). Being a user and spreading the word is vital for our engine, as we don't have a big marketing budget and rely on the community to grow.
+
+
+### Make games
+The best way to promote Stride is by creating a cool demo or, even better, a full game. Having people see and play an actual game made with Stride is the most effective form of advertisement.
+
+
+### [Donate](open-collective.md)
+We utilize Open Collective for fundraising. The funds collected are allocated towards bug bounties and compensating individuals contracted for paid work.
+
+
+### Submit bug reports
+Making Stride more stable greatly improves usability and user satisfaction. So if you encounter a bug during development, please contribute by reporting it on [Github](https://github.com/stride3d/stride/issues).
+
+
+### [PR reviews](https://github.com/stride3d/stride/pulls)
+Contributing to Pull Requests (PRs) is excellent as it enables active participation without local builds. Reviewing and offering feedback in this collaborative process enhances code quality and maintains project standards, fostering a sense of community and knowledge sharing.
+
+
+### [Contribute code](contribute-code.md)
+If you're passionate about C# and want to contribute by building features or fixing bugs in Stride, dive into the source code and get involved!
+Have a look at the Github issues label [Good first issue](https://github.com/stride3d/stride/labels/good%20first%20issue).
+
+### [Contribute to Documentation](contribute-documentation.md)
+Enhance the official documentation and tutorials by expanding the manual or creating textual/video guides. Your contributions will greatly improve accessibility and understanding for users.

+ 9 - 0
en/index.md

@@ -33,6 +33,15 @@ Welcome to the Stride documentation, specifically designed for game developers,
             <p class="px-3 mb-4"><a class="stretched-link" href="ReleaseNotes/index.md">Find Stride Release Notes</a></p>
             <p class="px-3 mb-4"><a class="stretched-link" href="ReleaseNotes/index.md">Find Stride Release Notes</a></p>
         </div>
         </div>
     </div>
     </div>
+    <div class="col-md-6">
+        <div class="card h-100">
+            <div class="card-body">
+                <h2 class="card-title h5">🌟 Contributors</h2>
+                <p class="card-text">Learn how you can contribute to Stride's development.</p>
+            </div>
+            <p class="px-3 mb-4"><a class="stretched-link" href="contributors/index.md">Start contributing to Stride</a></p>
+        </div>
+    </div>
     <div class="col-md-6">
     <div class="col-md-6">
         <div class="card h-100">
         <div class="card h-100">
             <div class="card-body">
             <div class="card-body">

+ 2 - 0
en/toc.yml

@@ -14,6 +14,8 @@
   #   href: tutorials/csharpintermediate/index.md
   #   href: tutorials/csharpintermediate/index.md
 - name: 📝 Release Notes
 - name: 📝 Release Notes
   href: ReleaseNotes/ReleaseNotes.md
   href: ReleaseNotes/ReleaseNotes.md
+- name: 🌟 Contributing
+  href: contributors/index.md
 - name: 🔧 API
 - name: 🔧 API
   href: api/
   href: api/
   homepage: api/index.md
   homepage: api/index.md