From 72ad157b07b3ecce0f185efd4d571d626bc17542 Mon Sep 17 00:00:00 2001 From: John R Barker Date: Mon, 12 Feb 2018 10:54:06 +0000 Subject: [PATCH] Change wording of Going Further section (#35949) (#36032) * Change wording of Going Further section The original wording was confusing with its non-devel branch part. Made it much clearer for people to understand what to do. Also removed the git command for creating branches, I believe a develop should be aware of how basic git commands work. (cherry picked from commit d5ae63c0ea29b3f5775494153264dee9686ee947) --- .../rst/dev_guide/developing_modules_general.rst | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/docsite/rst/dev_guide/developing_modules_general.rst b/docs/docsite/rst/dev_guide/developing_modules_general.rst index 8809f7c053..0fcedbbada 100644 --- a/docs/docsite/rst/dev_guide/developing_modules_general.rst +++ b/docs/docsite/rst/dev_guide/developing_modules_general.rst @@ -291,15 +291,15 @@ test/units/modules/.../test/my_new_test_module.py`` Going Further ============= -If you are starting new development or fixing a bug, create a new branch: +If you would like to contribute to the main Ansible repository +by adding a new feature or fixing a bug, `create a fork `_ +of the Ansible repository and develop against a new feature +branch using the ``devel`` branch as a starting point. -``$ git checkout -b my-new-branch``. - -If you are planning on contributing -back to the main Ansible repository, fork the Ansible repository into -your own GitHub account and develop against the new non-devel branch -in your fork. When you believe you have a good working code change, -submit a pull request to the Ansible repository. +When you you have a good working code change, +submit a pull request to the Ansible repository by selecting +your feature branch as a source and the Ansible devel branch as +a target. If you want to submit a new module to the upstream Ansible repo, be sure to run through sanity checks first. For example: