1. Mailing Lists
  2. Contributors
  3. Re: How can functional people "really" participate in OCA?

Contributors mailing list archives

contributors@odoo-community.org

Browse archives

Re: How can functional people "really" participate in OCA?

Re: How can functional people "really" participate in OCA?

Avatar

Re: How can functional people "really" participate in OCA?

by
Tecnativa. S. L., Pedro M. Baeza
- 08/02/2020 13:32:32
I don't like Wiki pages as you propose, as we will duplicate data and have inconsistencies between both sources. There must be only one source. What we can do is to create a Wiki page for teaching how to propose a modification in README.rst files of the modules / README.md of the repository for newbie people that is not used to GitHub, and add massively in all the README files this link (we have tools for this) in a special section. Something like:

"""
Is this README not accurated or are there missing things you have detected? Please visit xxx to learn how you can propose changes in it.
"""

I know there's still the barrier of RST formatting, but usual redaction doesn't require it (and we can teach about usual formatting things like bold or italic - GitHub also includes some buttons for them in the top bar).

Regards.

Reference