Skip to content

Commit

Permalink
Update wikicontributing.rst (#19)
Browse files Browse the repository at this point in the history
##wikicontributing.rst
Changes miscellaneous text and titles so page corresponds with Contribution guidelines.
  • Loading branch information
Varhagna committed Nov 21, 2019
1 parent cbb7245 commit a5eacfc
Showing 1 changed file with 25 additions and 23 deletions.
48 changes: 25 additions & 23 deletions source/general/wikicontributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,64 +4,66 @@
Contributing to the Wiki
========================

Setting up the environment
Setting Up the Environment
==========================

To begin editing the wiki we first need to set our environment up. The prerequisites needed is just `python <https://www.python.org/downloads/>`_.
To begin editing the Wiki, you first need to your environment. `Python`_ is the only dependency required.

.. note:: When installing python make sure too tick the ``Add Python to PATH`` option to be able to use python within your terminal/command prompt
.. note:: When installing Python make sure to tick the ``Add Python to PATH`` option to be able to use python within your terminal/command prompt

First thing you need to do is to fork the git repository and then clone it.

.. note:: Remember to replace *exampleusername* with your actual github username
1. Fork the GitHub repository and clone it.

.. note:: Remember to replace *YOUR\_USERNAME* with your GitHub username.

.. code:: bash
git clone https://github.com/exampleusername/ProjectKorraWiki.git
git clone https://github.com/YOUR_USERNAME/ProjectKorraWiki.git
The wiki is made with sphinx using the *sphinx_rtd_theme* from readthedocs. We've bundled all you need into one file.
Navigate to the directory you cloned the project to, then we will install all the requirements by running the following command in terminal / command prompt
The wiki is built with Sphinx using the *sphinx_rtd_theme* from ReadTheDocs.
Navigate to the directory you cloned the project to, then it will install all the requirements by running the following command in terminal / command prompt.

.. code:: bash
pip install -r .\requirements.txt
This should install both sphinx as well as the theme.
This should install both Sphinx as well as the theme.

To check that sphinx is correctly install run:
To check that Sphinx is correctly installed, run:

.. code:: bash
sphinx-build -version
If sphinx has been installed correctly it should output sphinx-build and the version number For example ``sphinx-build 1.7.5``
If Sphinx has been installed correctly, it should output sphinx-build and the version number. (ex. ``sphinx-build 1.7.5``)

The reason we need sphinx is so you can view your changes locally before you submit your changes as a pull request.
Sphinx is required to view your changes locally before submitting them.

Viewing your changes locally
============================
Viewing Local Changes
=====================

Once you have made some changes and you are ready to see your edits locally open terminal / command prompt and run
Once you have made some changes and are ready to see your edits locally, open terminal / command prompt and run

.. code:: bash
.\make.bat html
This should build a copy of the wiki into the build folder in the root directory of your repository.
To view the wiki double click on ``build > html > index.html``
This should build an HTML version of the wiki in the build folder ("build\html\index.html") in the root directory of your repository under the html folder.

Submitting your changes
=======================
Submitting Changes
==================

Now that you are happy with your changes remember to commit them using git and make sure to put a detailed message indicating what you have done.
If you are fixing/completing an issue please also reference the issue number in your commit message.
If you are working on an issue, please include a link to the corresponding GitHub Issue / Trello Card in your commit description.

Now you are ready to make a pull request so go ahead and create one `here <https://github.com/ProjectKorra/ProjectKorraWiki/compare>`_.
You are now ready to make a pull request which you can create `here <https://github.com/ProjectKorra/ProjectKorraWiki/compare>`_.

Remember to select compare across forks as shown in the screenshot below
Remember to compare across forks as shown in the screenshot below

.. image:: /_static/images/contributing_pr_1.png

Once you are ready and content with your changes hit the *Create pull request* button
Once you are ready and content with your changes hit the *Create pull request* button and fill out the template with the corresponding information.

Your changes will be reviewed and then merged by the Wiki Team. They may request changes and delay merging if they find any errors.

.. TODO:// More screenshots need to be placed here.

0 comments on commit a5eacfc

Please sign in to comment.