Second Hacktoberfest PR - Making Some Improvements

My Issue/Addition

      As I was searching for a new project/repo to contribute too, I just couldnt get over the feeling that my last PR was not complete to my satisfaction and I needed to make some changes to it before I could feel like I was done with it. I decided to create another issue on the repo to address these improvements


Creating the Script/Making a Pull Request

    I started out by researching the most popular online pc games and finding the servers that are used for most major regions. In my initial script, I was thinking on a more personal level and included only games that I play and that would really limit the usefulness of the script. Once I found as many games as I could, I added their information to the json file I had created to hold the game server information. I then had to modify the script code to accommodate these new games. Afterwards I updated the readme documentation to include the new functionality and made my pull request. 

Review Process

    The review process this time was more streamlined as I was already familiar with linting and flake8 and how this repo went about approving pull requests. 

Final Thoughts

This experience definitely taught me that you are never really done with a project and you can always continue to improve it. I will continue to keep this script in the back of my mind but now I am ready to move onto to something new and continue to gain more experience. 

Comments

Post a Comment

Popular posts from this blog

Planning for Release 0.4

 For this final release I was able to find a project that has created a reddit bot that scans titles in reddit subreddits and if it matches the criteria laid out in the code it offers the poster some useful resources and/or some great projects to begin practicing coding. I thought this was a worthwhile project as this is something that would definitely be helpful to me and it seems like a great addition to the programming  community.  The specific issue that I wanted to work on was one were the creator of the bot had all the code for the bot basically in one python file and the file was growing to over 500 lines and he wanted to move to a more modular approach that would include separating out the logic into different files. I thought this would be a good issue to tackle because it would require me to get a full understanding of the code as well as add optimizations throughout while a separated out the code.  The approach I plan to take is first to review the code so I can get a more
Read more

Adding Features and Pull Request

Week 3 OSD600 - Pull Requests   This week, our class took a look at each other's release from the previous week and were tasked with finding an issue or suggesting an improvement/adding a feature and then implementing that fix or improvement in the from of a  pull request. This week I decided to once again took a look at Matt's CheckMyLinks python tool.  Finding Issues or Suggesting an Improvement While reviewing Matt's code, I couldn't really find any issues that I could fix, so I instead I decided to look for ways I could think of to improve his tool. I had a couple ideas but the one I decided to go with was to add an option that would allow the user to save the results of the link check to a text file. I thought this would be useful so the user can have a reference of the results after leaving the command line. I left an issue request on Matt's repo and began to implement the improvement.  Implementing Improvement   The first thing I did when starting to code t
Read more

Release 0.4 Progress - Organizing the code

 After taking some time to understand the code that runs the bot, I was able to separate the code out into a few different categories that would be placed into their own files, code that creates the classes that manage the checking of reddit posts and comments, code that manages the bot streaming and posting to reddit, code that initialized the initial state of the bot and code that provides general utility to the bot.  Once I was able to separate out all that logic, the next issue I need to tackle now is how to make the code work while flowing through these different files. Currently since the app operates in one file, the bot creator has been making use of a lot of global variables instead of constantly passing variables through several functions. I dont think this solution is ideal so I currently I am working on a more efficient solution that doesnt involve passing several variables across functions and files. I think perhaps creating a dictionary that contains critical data that ca
Read more