Skip to content

Commit

Permalink
Final changes
Browse files Browse the repository at this point in the history
  • Loading branch information
RCheesley committed Nov 3, 2024
1 parent 21cd9cf commit 088797b
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions docs/contributing/contributing_docs_rst.rst
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ To do this follow these steps:
Hurrah, now you're ready to get started with contributing to the documentation. 🥳

Making your first pull request
=============================
==============================

When you want to make a change in the documentation, you need to submit a Pull Request - PR - to the relevant repository. This is a request to the maintainers of the repository to merge your changes into the main branch of the repository. While it sounds a bit confusing, once you've done it a few times it becomes second nature.

Expand Down Expand Up @@ -81,7 +81,7 @@ Here's how to get started:
:width: 600px
:align: center

7. Commit your changes to your local repository by running the following command in your terminal: ``git add <filename>`` to stage specific files, and then ``git commit -m "A brief description of the changes you made"`` - for example, ``git commit -m "Fix typo in introduction"``. You can also do this in the VSCode editor by clicking on the source control icon in the left-hand toolbar, staging the files you want to commit, and then adding a commit message.
7. Commit your changes to your local repository by running the following command in your terminal: ``git add <filename>`` to stage specific files, and then ``git commit -m "A brief description of the changes you made"`` - for example, ``git commit -m "Fix typo in introduction"``. You can also do this in the VSCode editor by clicking on the source control icon in the left-hand toolbar, staging the files you want to commit by clicking the plus icon which appears on hover, and then adding a commit message in the box above.

Check warning on line 84 in docs/contributing/contributing_docs_rst.rst

View workflow job for this annotation

GitHub Actions / prose

[vale] reported by reviewdog 🐶 [Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Stage' instead of 'stage'. Raw Output: {"message": "[Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Stage' instead of 'stage'.", "location": {"path": "docs/contributing/contributing_docs_rst.rst", "range": {"start": {"line": 84, "column": 126}}}, "severity": "INFO"}

.. image:: images/staging_changes.png
:alt: VSCode screenshot showing how to stage and commit changes

Check warning on line 87 in docs/contributing/contributing_docs_rst.rst

View workflow job for this annotation

GitHub Actions / prose

[vale] reported by reviewdog 🐶 [Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Stage' instead of 'stage'. Raw Output: {"message": "[Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Stage' instead of 'stage'.", "location": {"path": "docs/contributing/contributing_docs_rst.rst", "range": {"start": {"line": 87, "column": 44}}}, "severity": "INFO"}
Expand All @@ -90,5 +90,5 @@ Here's how to get started:

8. Push your changes to your fork of the repository by running the following command in your terminal: ``git push origin <branch-name>`` - for example, ``git push origin fix-typo-in-introduction``. This sends your changes to your fork on GitHub. To do this in the VSCode editor, first publish the branch by clicking on the blue button in the version control panel, and then push the changes by clicking on the three dots next to the branch name and selecting 'Push' or clicking the blue button marked 'synchronize changes'. Continue to make and stage changes and synchronize in this way until you've completed your work.

9. Go back to the original repository - not your fork, but the upstream version - and create a new pull request by clicking on the green button which shows at the top of the page. This takes you to a page where you can review the changes you've made, and add a description of what you've done. Once you're happy with the changes, click on the 'Create pull request' button to submit your changes for review.
9. Go back to the original repository - not your fork, but the upstream version - and create a new pull request by clicking on the green button which shows at the top of the page. This takes you to a page where you can review the changes you've made, and add a description of what you've done. Once you're happy with the changes, click the 'Create pull request' button to submit your changes for review.

Check warning on line 93 in docs/contributing/contributing_docs_rst.rst

View workflow job for this annotation

GitHub Actions / prose

[vale] reported by reviewdog 🐶 [Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Landing Page' instead of 'page'. Raw Output: {"message": "[Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Landing Page' instead of 'page'.", "location": {"path": "docs/contributing/contributing_docs_rst.rst", "range": {"start": {"line": 93, "column": 175}}}, "severity": "INFO"}

Check warning on line 93 in docs/contributing/contributing_docs_rst.rst

View workflow job for this annotation

GitHub Actions / prose

[vale] reported by reviewdog 🐶 [Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Landing Page' instead of 'page'. Raw Output: {"message": "[Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Landing Page' instead of 'page'.", "location": {"path": "docs/contributing/contributing_docs_rst.rst", "range": {"start": {"line": 93, "column": 201}}}, "severity": "INFO"}

0 comments on commit 088797b

Please sign in to comment.