kantord / LibreLingo

🐢 🌎 📚 a community-owned language-learning platform
https://librelingo.app
GNU Affero General Public License v3.0
1.94k stars 213 forks source link

Clarifying contributing guidelines in documentation and README.md #3376

Closed beanrill closed 2 months ago

beanrill commented 4 months ago

I am wondering if there should be more clarification in the documentation on how to contribute to this project. First, in README.md under "are you a developer?" I would suggest redirecting the [here] link in "Go through the dev docs [here]" directly to the Contributing section of the documentation.

Second, it's unclear what the process should exactly be when wanting to contribute. The README.md and the Contributing section of the documentation page say different things. Should contributors submit an issue first then a pull request? If so, should that be noted on both the README.md and the documentation page?

An example set of steps could look like:

How to Contribute

beanrill commented 2 months ago

PR #3377