From a1c458837f0543d88d44e98d4dc379ef54e88b6e Mon Sep 17 00:00:00 2001 From: Jacob Humphrey Date: Tue, 31 Jul 2018 03:36:32 -0500 Subject: [PATCH] doc: update writingdocs.rst to merge request --- doc/help/contributing/writingdocs.rst | 54 +++------------------------ 1 file changed, 5 insertions(+), 49 deletions(-) diff --git a/doc/help/contributing/writingdocs.rst b/doc/help/contributing/writingdocs.rst index 1eb3fbd33..aa456898e 100644 --- a/doc/help/contributing/writingdocs.rst +++ b/doc/help/contributing/writingdocs.rst @@ -1,6 +1,6 @@ -.. _`Builder Gitlab Issues`: https://gitlab.gnome.org/GNOME/gnome-builder/issues/new -.. _`Builder Bugzilla`: https://bugzilla.gnome.org/enter_bug.cgi?product=gnome-builder&component=docs -.. _`git workflow`: https://wiki.gnome.org/Newcomers/SubmitPatch +.. _`merge request`: https://wiki.gnome.org/Newcomers/SubmitContribution +.. _`gitlab`: https://gitlab.gnome.org/GNOME/gnome-builder + ##################### @@ -40,49 +40,5 @@ Submitting Patches We will accept patches for documentation no matter how you get them to us. However, you will save us a lot of time if you can: - * Create a patch with git. - * Create a new bug on `Builder Gitlab Issues`_ and attach the patch. - -Creating a Patch -================ - -First off, if you have not configured git to include your full name and email, type the following in a terminal: - -.. code-block:: bash - - $ git config --global user.name 'My Full Name' - $ git config --global user.email 'example@example.com' - -After you have modified the documentation to your liking, prepare the files to be committed to git. -The add a short commit message and commit the files. - -.. code-block:: bash - - [user@host doc/]$ git add path/to/file.rst - [user@host doc/]$ git commit -m 'doc: update example documentation' - -Now we can export the patch to be uploaded to `Builder Gitlab Issues`_ - -.. code-block:: bash - - [user@host doc/]$ git format-patch HEAD^ - -At this point you'll see a file similar to ``0001-doc-update-example-documentation.patch`` in the current directory. -We want to upload this patch to `Builder Gitlab Issues`_. - -Submitting a Patch -================== - -Now that we have our patch file, we need to create a new bug. -Head over to `Builder Gitlab Issues`_ and fill out the bug details. - -Just give a bit of information about what you documented, and then find the "Add an Attachment" section near the bottom. -Upload the patch file you exported with ``git format-patch HEAD^`` above. - -Click "Submit Bug" and we'll take care of the rest! - -GNOME git Best Practices -======================== - -To learn more about using git with GNOME, including how to set up git, submitting patches, -and good commit messages, visit the `git workflow`_ GNOME wiki page. + * Create a fork on `gitlab`_. + * Create a `merge request`_ on `gitlab`_. -- GitLab