# Contributors/Maintainers experience ###### tags: `contributor summit` ### Ansible Contributor Summit March 2021 #### How do we improve the experience of contributors and maintainers ? This session is an opportunity for contributors and maintainers to get together and discuss what would make their work easier when submitting code, reviewing it or merging it. It's great to give tips or advice and highlight the things that are working well too ! The time we have for the session doesn't allow us to go deep into the details and the solutions but we would like to record this information so we can use it in the future to improve the experience of contributors and maintainers. Feel free to add questions, improvement opportunities or pain points below so we can talk about it. ### Contributing code * Each Collection's README should have * Link to general "How to checkout and develop Ansible Collections" * Which in turn links to https://www.katacoda.com/ansible-community/scenarios/fixing-a-bug * Details about the specifics for how to develop & contribut to this collection * Any Python dependencies * * Writing unit tests is not always easy in python, integration tests as ansible roles and playbooks are easier ### Reviewing & Merging code * ### CI & Tooling * Is shippable still in use somewhere ? * What do you use for CI and are you happy with it ? * GitHub actions ? * Azure pipelines ? * Zuul ? * Something else ? * Do you use any of the following tools for testing ? Any tips or feedback ? * [ansible-test](https://docs.ansible.com/ansible/latest/dev_guide/testing.html) * [ansible-lint](https://github.com/ansible-community/ansible-lint) * [molecule](https://github.com/ansible-community/molecule) * [ara](https://github.com/ansible-community/ara) * [ansibullbot](https://github.com/ansible/ansibullbot) * Experience with patchback bot ? * It's great (felixfontein)! thanks (webknjaz)! ### Other * Requirement on collections to live under an ansible_collections directory * Documentation is a challenge -- no specific instructions or standardized documentation for contributing to individual collections * For example https://sensu.github.io/sensu-go-ansible/hacking.html * Some documentation about collections is still in TODO/TBD (https://docs.ansible.com/ansible/devel/dev_guide/developing_collections.html#roles-directory) — specifically, roles+playbooks content inside of pre-existing collections. Also, is it necessary to have README and metadata files inside the role folders (`ns/collection/roles/role_name/{galaxy.yml,README.md}`?) * Extra thoughts: README in subfolders is probably not required but *may be useful (optionally)*; galaxy.yml also shouldn't be necessary because `ansible-galaxy` CLI works with the top-level metadata file and does not operate on the subfolders with content directly. (webknjaz)