Major update to chorus.services platform
- Extensive updates to system configuration and deployment - Enhanced documentation and architecture improvements - Updated dependencies and build configurations - Improved service integrations and workflows 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
100
brand-assets/packs/collaborator/kit.md
Normal file
100
brand-assets/packs/collaborator/kit.md
Normal file
@@ -0,0 +1,100 @@
|
||||
A collaborator or code-contributor pack is aimed at **developers, artists, or other contributors** who might join your project. The goal is to give them **everything they need to understand, evaluate, and start contributing**, without being overwhelming. For a solo indie project, clarity and structure are key.
|
||||
|
||||
Here’s what to include:
|
||||
|
||||
---
|
||||
|
||||
### **1. Cover / Intro**
|
||||
|
||||
* Project name and logo.
|
||||
* Tagline or short mission statement.
|
||||
* High-level project overview in 1–2 sentences.
|
||||
|
||||
---
|
||||
|
||||
### **2. Project Overview**
|
||||
|
||||
* Genre, style, and scope of the project.
|
||||
* Core mechanics or features.
|
||||
* Current development stage (prototype, alpha, early access).
|
||||
* Vision and goals: what you hope to achieve creatively and technically.
|
||||
|
||||
---
|
||||
|
||||
### **3. How to Contribute**
|
||||
|
||||
* Areas of contribution needed (coding, art, sound, testing, level design).
|
||||
* How contributions will be managed (GitHub, GitLab, other VCS).
|
||||
* Coding standards or style guides (languages, frameworks, naming conventions).
|
||||
* Branching and pull request workflow.
|
||||
* Testing and QA procedures.
|
||||
|
||||
---
|
||||
|
||||
### **4. Technical Overview**
|
||||
|
||||
* Tech stack: languages, engines, libraries, frameworks.
|
||||
* Hardware/software requirements for running the project locally.
|
||||
* Build instructions (how to compile/run the project).
|
||||
* Dependencies and installation guides.
|
||||
* Architecture overview (how code is organized, major modules).
|
||||
|
||||
---
|
||||
|
||||
### **5. Assets & Tools**
|
||||
|
||||
* Links to art, audio, or other assets contributors can use.
|
||||
* Versioning info (if assets are managed separately).
|
||||
* Any proprietary tools, scripts, or plugins used in development.
|
||||
|
||||
---
|
||||
|
||||
### **6. Documentation**
|
||||
|
||||
* Links to detailed code documentation or API references.
|
||||
* In-line comments and style notes.
|
||||
* Roadmap for features or sprints (so contributors know priorities).
|
||||
|
||||
---
|
||||
|
||||
### **7. Community & Communication**
|
||||
|
||||
* Slack, Discord, or other chat channels.
|
||||
* Forum or issue tracker guidelines.
|
||||
* Code review process (who reviews, turnaround time).
|
||||
* Expected commitment or contribution etiquette.
|
||||
|
||||
---
|
||||
|
||||
### **8. Licensing & Legal**
|
||||
|
||||
* Open-source or proprietary license (MIT, GPL, proprietary, etc.).
|
||||
* Contributor license agreements if required.
|
||||
* IP ownership clarifications (who retains rights to contributions).
|
||||
|
||||
---
|
||||
|
||||
### **9. Quick Start / First Task**
|
||||
|
||||
* A simple, low-friction task to get new contributors involved.
|
||||
* Example: fix a small bug, add a small feature, polish an asset.
|
||||
* Step-by-step instructions to get up and running.
|
||||
|
||||
---
|
||||
|
||||
### **10. Contact / Support**
|
||||
|
||||
* Primary point of contact (email, messaging).
|
||||
* How contributors should ask questions or report issues.
|
||||
* Optional: links to FAQs or developer guides.
|
||||
|
||||
---
|
||||
|
||||
**Tips:**
|
||||
|
||||
* Make it **modular**: some contributors only need the technical overview, some only need art assets—don’t force them to wade through everything.
|
||||
* Include **visuals and diagrams** for architecture, workflows, or asset pipelines.
|
||||
* Keep setup instructions simple—new contributors often drop out if onboarding is too complex.
|
||||
* Highlight **low-friction ways to contribute first**, then deeper tasks once they’re familiar.
|
||||
|
||||
---
|
||||
Reference in New Issue
Block a user