diff options
| author | Matt Clay <mclay@redhat.com> | 2020-03-26 12:19:01 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-03-26 15:19:01 -0400 |
| commit | 4fc10186b964809706dea841cad26778de9c00a3 (patch) | |
| tree | f067c9941e81f5a996e82f47627dbdc5093657d2 | |
| parent | 59454153984da2e9127931194d26180ca3e99ee6 (diff) | |
| download | ansible-4fc10186b964809706dea841cad26778de9c00a3.tar.gz | |
Move coding guidelines links to readme. (#68479)
| -rw-r--r-- | CODING_GUIDELINES.md | 10 | ||||
| -rw-r--r-- | README.rst | 8 | ||||
| -rwxr-xr-x | test/sanity/code-smell/package-data.py | 1 |
3 files changed, 8 insertions, 11 deletions
diff --git a/CODING_GUIDELINES.md b/CODING_GUIDELINES.md deleted file mode 100644 index 4b3792be2d..0000000000 --- a/CODING_GUIDELINES.md +++ /dev/null @@ -1,10 +0,0 @@ -Coding Guidelines -================= - -Hi! Thanks for your interest in contributing to Ansible. We document our Coding Guidelines in the [Developer Guide](https://docs.ansible.com/ansible/devel/dev_guide/). We particularly suggest you review: - -* [Contributing your module to Ansible](https://docs.ansible.com/ansible/devel/dev_guide/developing_modules_checklist.html) - -* [Development conventions, tips and pitfalls](https://docs.ansible.com/ansible/devel/dev_guide/developing_modules_best_practices.html) - -Our [Community Guide](https://docs.ansible.com/ansible/devel/community/) may also help you connect with the community of Ansible developers. diff --git a/README.rst b/README.rst index 8684401c22..150900da81 100644 --- a/README.rst +++ b/README.rst @@ -58,6 +58,14 @@ Get Involved * For a list of email lists, IRC channels and Working Groups, see the `Communication page <https://docs.ansible.com/ansible/latest/community/communication.html>`_ +Coding Guidelines +================= + +We document our Coding Guidelines in the `Developer Guide <https://docs.ansible.com/ansible/devel/dev_guide/>`_. We particularly suggest you review: + +* `Contributing your module to Ansible <https://docs.ansible.com/ansible/devel/dev_guide/developing_modules_checklist.html>`_ +* `Conventions, tips and pitfalls <https://docs.ansible.com/ansible/devel/dev_guide/developing_modules_best_practices.html>`_ + Branch Info =========== diff --git a/test/sanity/code-smell/package-data.py b/test/sanity/code-smell/package-data.py index c408ecb64d..a1357a7b8d 100755 --- a/test/sanity/code-smell/package-data.py +++ b/test/sanity/code-smell/package-data.py @@ -62,7 +62,6 @@ def assemble_files_to_ship(complete_file_list): 'examples/plugin_filters.yml', 'hacking/env-setup', 'hacking/env-setup.fish', - 'CODING_GUIDELINES.md', 'MANIFEST', )) |