docs/docsite/rst/community/committer_guidelines.rst
.. _community_committer_guidelines:
Committers Guidelines
These are the guidelines for people with commit privileges on the repositories in the ansible and ansible-collections GitHub organizations.
Committers of Ansible-core <https://github.com/ansible/ansible>_ are necessarily Red Hat employees acting as members of the Ansible Core team. Committers of Ansible collections <https://github.com/ansible-collections/>_ are members of the community or Ansible Engineering. Please read the guidelines before you commit.
These guidelines apply to everyone. At the same time, this is NOT a process document. So just use good judgment. You have been given commit access because we trust your judgment.
That said, use the trust wisely.
If you abuse the trust and break components and builds, and so on, the trust level falls and you may be asked not to commit or you may lose your commit privileges.
As a core team member, you are an integral part of the team that develops the :ref:roadmap <roadmaps>. Please be engaged, and push for the features and fixes that you want to see. Also keep in mind that Red Hat, as a company, will commit to certain features, fixes, APIs, and so on, for various releases. Red Hat, the company, and the Ansible team must get these changes completed and released as scheduled. Obligations to users, the community, and customers must come first. Because of these commitments, a feature you want to develop yourself may not get into a release if it affects a lot of other parts within Ansible.
Any other new features and changes to high level design should go through the proposal process (TBD), to ensure the community and core team have had a chance to review the idea and approve it. The core team has sole responsibility for merging new features based on proposals to Ansible-core <https://github.com/ansible/ansible>_.
Collections maintainers define features, high-level design, and roadmap of the collections themselves and are responsible for merging new features to Ansible collections <https://github.com/ansible-collections/>_ based on proposals discussed with their communities.
As a committer, you may already know this, but our workflow forms a lot of our team policies. Please ensure you are aware of the following workflow steps:
The Core Team is aware that this can be a difficult process at times. Sometimes, the team breaks the rules by making direct commits or merging their own pull requests. This section is a set of guidelines. If you are changing a comma in documentation, or making a very minor change, you can use your best judgment. This is another trust thing. The process is critical for any major change, but for little things or getting something done quickly, use your best judgment and make sure people on the team are aware of your work.
Module maintainers <maintainers>: Module maintainers own specific modules and have indirect commit access through the current module pull request mechanisms.Collection maintainers <maintainers>: Collection maintainers own specific collections and have commit access to them. Each collection can set its own rules for contributions... _committer_general_rules:
Individuals with direct commit access are entrusted with powers that allow them to do a broad variety of things--probably more than we can write down. Rather than rules, treat these as general guidelines, individuals with this power are expected to use their best judgment.
Do NOT
code_of_conduct.Do
tests<developing_testing> and be sure that other's pull requests you are reviewing are covered well. Pull requests with tests are looked at with more priority than pull requests without tests that should have them included. While not all changes require tests, be sure to add them for new features, bug fixes, and functionality changes.ansible-core or collection against which this documentation is compatible (to avoid confusion between stable and devel docs, for backwards compatibility, and so on).Committers are expected to continue to follow the same community and contribution guidelines followed by the rest of the Ansible community.