diff options
| author |  xedre <[email protected]> | 2018-10-06 09:00:32 +0100 |
|---|---|---|
| committer |  GitHub <[email protected]> | 2018-10-06 09:00:32 +0100 |
| commit | 580ba3065f208982a187d22787ad0727f013f941 (patch) | |
| tree | ca79ad748d1169c8701beb65f83e4e7f6a9e9299 /README.md | |
| parent | Began working on getting started (diff) | |
Finished getting started
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 41 |
1 files changed, 41 insertions, 0 deletions
@@ -62,3 +62,44 @@ Go back to PyCharm and you should have something a bit like below, Your going to  We are going to want to choose a python config as below:  +The first setting we need to change is script path as below (the start script may have changed from bot.py so be sure to click the right one + +Now we need to add an enviroment variable - what this will do is allow us to set a value without it affact the main repository. +To do this click the folder icon to the right of the text, then on the new window the plus icon. Now name the var `HACKTOBERBOT_TOKEN` and give the value the token we kept for safe keeping earilier. + +Now hit apply on that window and your ready to get going! +#### 5. Git in PyCharm +As we work on our project we are going to want to make commits. Commits are effectively a list of changes you made to the pervious version. To make one first hit the green tick in the top right + +1. Select the files you wish to commit +2. Write a brief description of what your commit is +3. See the actual changes you commit does here (you can also turn some of them off or on if you wish) +4. Hit commit + + +Now once you have made a few commits and are happy with your changes you are going to want to push them back to your fork. +There are three ways of doing this. +1. using the VSC Menu `VSC->Git->Push +2. using the VSC popup <code>alt-\`->Push</code> +3. or a shortcut: `ctrl+shift+K` + +You should get a menu like below: +1. list of commits +2. List of changed files +3. Hit Push to send to fork! + + +#### 6. Pull Requests (PR or PRs) +Goto https://github.com/discord-python/hacktoberbot/pulls and the green New Pull Request button! + +Now you should hit `Compare across forks` then on the third dropdown select your fork (it will be `your username/hacktoberbot`) then hit Create Pull request. +1[](https://i.imgur.com/N2X9A9v.png) +Now to tell other people what your PR does +1. Title - be concise and informative +2. Description - write what the PR changes as well as what issues it relates to +3. Hit `Create pull request` + +#### 7. Wait & further reading +At this point your PR will either be accepted or a maintainer might request some changes. + +So you can read up some more on (Git)[https://try.github.io], (PyCharm)[https://www.jetbrains.com/help/pycharm/quick-start-guide.html] or you might want to learn more about Python and discord: (discord.py rewrite)[https://discordpy.readthedocs.io/en/rewrite/] |