search

wger-project / flutter

Flutter fitness/workout app for wger
GNU Affero General Public License v3.0
572 stars 245 forks source link

Improve Contribution Guidelines #590

Open leese5 opened 6 months ago

leese5 commented 6 months ago

Use case

I noticed that the contribution guidelines could be expanded and clarified to better support new contributors. Comprehensive guidelines can make the process more transparent and encourage more community participation. Currently, there are several areas that could benefit from additional detail, such as the process for reporting issues, submitting pull requests, and engaging in discussions.

Proposal

  1. Reporting Issues: Add a detailed section on how to report issues, including what information to include and how to format the issue for clarity.
  2. Submitting Pull Requests: Provide a step-by-step guide on how to submit pull requests, including forking the repository, creating a new branch, making changes, and submitting a pull request.
  3. Code of Conduct: Include a section that outlines the expected behavior of contributors and maintainers.
  4. Review Process: Describe the process for code reviews, including what contributors can expect and how they can address feedback.
  5. Discussion Participation: Encourage participation in discussions and provide guidelines on how to engage respectfully and constructively.

Reference: https://numpy.org/devdocs/dev/index.html

Dieterbe commented 6 months ago

there is some existing work towards this: #240

that said, i wouldn't make it any more complicated or verbose than it needs to be:

Dieterbe commented 6 months ago

i also think wger users think of "wger" as one thing/project. However, the code is split over 3 core repositories: wger (backend), wger-react (web frontend) and flutter (mobile app). The contribution process is similar for all these (especially wrt. translations, and docs, which goes in yet another repository, and while it currently doesn't mention the mobile app, i would say in the docs repo we should handle the docs for the whole wger "system") Users are also more likely to find their way to the wger homepage rather than individual project repos on github.

Therefore, my suggestion is to write 1 contribution guide that covers everything (and links to the individual repos), and make this page available on (or via) wger.de and on https://wger.readthedocs.io We can also make a readme for the wger organization itself, which would appear on https://github.com/wger-project - this also seems like a good place to put it.

i think it will be less common that people will look for contribution guides in the individual repos themselves, alhough we could make them, and simply refer to the main one

rolandgeider commented 5 months ago

I also see wger as one "thing", but you are of course right that there are a lot of different snippets of wisdom info in a lot of READMEs scattered around. We should definitely consolidate as much as possible on the docs repo, which is automatically published