Contributing
View Source STDIN1 # Macula HTTP/3 Mesh - Contributing Guide 2 3 How to contribute to Macula 4 5 Status: 🚧 SKELETON - Needs completion 6 Priority: P2 7 Estimated effort: 4 hours 8 9 --- 10 11 ## Welcome 12 13 ⚠️ TODO: Welcome message for contributors. 14 15 --- 16 17 ## Code of Conduct 18 19 ⚠️ TODO: Community code of conduct. 20 21 --- 22 23 ## Development Setup 24 25 ⚠️ TODO: How to set up development environment. 26 27 Sections needed: 28 - Prerequisites 29 - Fork and clone 30 - Install dependencies 31 - Run tests 32 - Start local mesh 33 34 --- 35 36 ## Testing Requirements 37 38 ⚠️ TODO: Testing standards. 39 40 Topics: 41 - Unit tests (EUnit/ExUnit) 42 - Integration tests 43 - Property-based tests (PropEr/StreamData) 44 - Coverage requirements 45 46 --- 47 48 ## Code Style Guide 49 50 ⚠️ TODO: Erlang/Elixir coding conventions. 51 52 Topics: 53 - Formatting (mix format, erlfmt) 54 - Naming conventions 55 - Documentation requirements 56 - Type specifications 57 58 --- 59 60 ## Documentation Requirements 61 62 ⚠️ TODO: How to document code. 63 64 --- 65 66 ## Pull Request Process 67 68 ⚠️ TODO: PR workflow. 69 70 Steps: 71 1. Create feature branch 72 2. Make changes 73 3. Write tests 74 4. Update docs 75 5. Submit PR 76 6. Code review 77 7. Merge 78 79 --- 80 81 ## Release Process 82 83 ⚠️ TODO: How releases are managed. 84 85 --- 86 87 ## Community Channels 88 89 ⚠️ TODO: Where to get help and discuss. 90 91 Channels: 92 - GitHub Discussions 93 - Discord server 94 - Mailing list 95 - Monthly community calls 96 97 --- 98 99 ## Roadmap and Feature Requests 100 101 ⚠️ TODO: How to propose new features. 102 103 --- 104 105 ## Reporting Issues 106 107 ⚠️ TODO: Bug report template and guidelines. 108 109 --- 110 111 ## Recognition 112 113 ⚠️ TODO: How contributors are recognized. 114 115 --- 116 117 Last Updated: 2025-01-08 118 Contributors: [Add names as sections are completed]