NETWAYS / ansible-collection-elasticstack

A collection to install and manage the Elastic Stack
GNU General Public License v3.0
9 stars 8 forks source link

Add documentation to "contribution" part of README #234

Open widhalmt opened 10 months ago

widhalmt commented 10 months ago

We have some rules in README.md. We should add, that every pull request must come with documentation for the change it introduces. Now is the time where we see more undocumented variables etc. .

And, as @xtruthx just experienced (sorry again for that), some more sophisticated parts of the code aren's as well documented as we all wished. So while using the collection seems to be quite straight forward, changes are hard because the more complex parts aren't easy to comprehend. Sometimes even usage is hard: See https://github.com/NETWAYS/ansible-collection-elasticstack/issues/218 for example.