element-hq / element-hq/element-x-android

contributing guide immediately sends new devs on goose chase

Open
#4,569 2 comments 0 reactions 0 assignees View on GitHub
Dominant language
Kotlin
Stars
2.4k
Forks
624
Avg merge
1d 14h
Merged PRs (30d)
149

Description

https://github.com/element-hq/element-x-android/blob/develop/CONTRIBUTING.md#contributing-code-to-matrix is the very first part of the guide and the first thing is says is to read https://github.com/matrix-org/synapse/blob/master/CONTRIBUTING.md but that just contains a link to https://matrix-org.github.io/synapse/latest/development/contributing_guide.html which says it is out of date since version 1.99 and to go to https://github.com/element-hq/synapse where if you scroll down it and read everything it will send you to https://element-hq.github.io/synapse/latest/development/contributing_guide.html

Is that supposed to be the FIRST thing new contributors to element-x-android read? Install Windows Subsystem for Linux? It doesn’t seem very relevant. Maybe move that down to the end of the guide, mention that it's for the backend of Element, and link to it directly?

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.