π₯π₯π₯ Open-source Jira, Linear, Monday, and ClickUp alternative. Plane is a modern project management platform to manage tasks, sprints, docs, and triage.
TypeScript boardsbug-trackerdjangodockerganttissue-trackerjirajira-alternativekanbanlinearpostgresqlproduct-managementproject-managementproject-planningpythonreactredistypesciptvitework-management
docs: document minimum RAM requirement and issue naming conventions (#6954)
alaabousselmifeb6243065cb
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.mdindex 0f5e99cb8e..68ef89085d 100644--- a/CONTRIBUTING.md+++ b/CONTRIBUTING.md@@ -15,6 +15,22 @@ Without said minimal reproduction, we won't be able to investigate all [issues](You can open a new issue with this [issue form](https://github.com/makeplane/plane/issues/new).+### Naming conventions for issues++When opening a new issue, please use a clear and concise title that follows this format:++- For bugs: `π Bug: [short description]`+- For features: `π Feature: [short description]`+- For improvements: `π οΈ Improvement: [short description]`+- For documentation: `π Docs: [short description]`++**Examples:**+- `π Bug: API token expiry time not saving correctly`+- `π Docs: Clarify RAM requirement for local setup`+- `π Feature: Allow custom time selection for token expiration`++This helps us triage and manage issues more efficiently.+## Projects setup and Architecture### Requirements@@ -23,6 +39,8 @@ You can open a new issue with this [issue form](https://github.com/makeplane/pla- Python version 3.8+- Postgres version v14- Redis version v6.2.7+- **Memory**: Minimum **12 GB RAM** recommended+ > β οΈ Running the project on a system with only 8 GB RAM may lead to setup failures or memory crashes (especially during Docker container build/start or dependency install). Use cloud environments like GitHub Codespaces or upgrade local RAM if possible.### Setup the project