matrix-docker-ansible-deploy icon indicating copy to clipboard operation
matrix-docker-ansible-deploy copied to clipboard

Create a contribution guide

Open luixxiul opened this issue 1 year ago • 0 comments

Is your feature request related to a problem? Please describe.

In order to welcome contributions from a lot of people, I would like to suggest to create a contribution guide. It might have been not necessary when this project has started as the Matrix ecosystem was constantly growing along with it, but since then several projects have stopped their development and some of them have been deprecated in favor of either its successors or other projects. IMHO it is important to keep the playbook up-to-date with the Matrix ecosystem, and for that object the more eyes and hands we have, the better it should be :)

Describe the solution you'd like

The contribution guide should have a section for:

  • How to create a playbook for a new integration
  • How to update the playbook if it gets out of date
  • How to test and spot a bug
  • How to improve documentation (including finding a typo)
  • How to help other people by answering questions
  • How to help other people who do not speak English

etc.

Create a CONTRIBUTING.md: https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/1657#issuecomment-1053382314

Describe alternatives you've considered

Additional context

luixxiul avatar Nov 03 '24 09:11 luixxiul