blob: 1319470a7ecc5a5349b165395cf73e04d0ea2fb1 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
|
Contributing to Ansible-lint
============================
To contribute to ansible-lint, please use pull requests on a branch
of your own fork.
After `creating your fork on GitHub`_, you can do:
.. code-block:: shell-session
$ git clone git@github.com:yourname/ansible-lint
$ cd ansible-lint
$ git checkout -b your-branch-name
# DO SOME CODING HERE
$ git add your new files
$ git commit -v
$ git push origin your-branch-name
You will then be able to create a pull request from your commit.
All fixes to core functionality (i.e. anything except docs or examples)
should be accompanied by tests that fail prior to your change and
succeed afterwards.
Feel free to raise issues in the repo if you feel unable to
contribute a code fix.
.. _creating your fork on GitHub:
https://guides.github.com/activities/forking/
Standards
---------
ansible-lint is flake8 compliant with ``max-line-length`` set to 100
(see `.flake8`_).
ansible-lint works only with `supported Ansible versions`_ at the
time it was released.
Automated tests will be run against all PRs for flake8 compliance
and Ansible compatibility — to check before pushing commits, just
use `tox`_.
.. _.flake8: https://github.com/ansible/ansible-lint/blob/master/.flake8
.. _supported Ansible versions:
https://docs.ansible.com/ansible/devel/reference_appendices
/release_and_maintenance.html#release-status
.. _tox: https://tox.readthedocs.io
.. DO-NOT-REMOVE-deps-snippet-PLACEHOLDER
Talk to us
----------
Discussion around ansible-lint happens in ``#ansible-galaxy`` IRC
channel on Freenode and the `Ansible Development List`_.
For the full list of Ansible IRC and Mailing list, please see the
`Ansible Communication`_ page.
Release announcements will be made to the `Ansible Announce`_ list.
Possible security bugs should be reported via email
to security@ansible.com.
.. _Ansible Announce:
https://groups.google.com/forum/#!forum/ansible-announce
.. _Ansible Development List:
https://groups.google.com/forum/#!forum/ansible-devel
.. _Ansible Communication:
https://docs.ansible.com/ansible/latest/community/communication.html
Code of Conduct
---------------
As with all Ansible projects, we have a `Code of Conduct`_.
.. _Code of Conduct:
https://docs.ansible.com/ansible/latest/community
/code_of_conduct.html
|
