Release 0.2 3rd Pull Request

Introduction
For this pull request, I wanted to build the confidence to work with a larger open source project. I was able to find the perfect oppurtunity to build my confidence in working in larger more complex projects with Pandas. Pandas is a data analysis tool that I have used before with python and it was powerful and highly recommended so contributing to the project was something that really interested me. 

Issue 
The code base for pandas was pretty complex and intimidating so for my first contribution I wanted to find an issue that was fairly simple just so I could get a feel for the contributing process for such a larger project. I was able to find an issue that had been filed that was marked as good for first time contributors. The issue was that they had several files that they wanted to move away from using dict() to create dictionaries and instead used python literal dicts to avoid having to ignore the flake8 errors they caused. Fixing this would be fairly simple so I picked a number of the files they had named in the issue and got to work. 

Pull Request 

Once I cloned the code base from github, I found the files I had decided to work and found all the calls to dict() and replaced them with literaly dicts. After each file I committed those changes. Once I was finished with all the files, I made sure they files were linted using flake8 and formatted using black like was indicted in the contributing documents. This was fairly easy as I had just learned how to use these tools in a recent lab and already had them set up. Once I was happy, I made a pull request. The biggest difference with this pull request opposed to others I have made was how extensive the pre-committ checks and workflow actions were. The pull request had to go through 16 checks which in total took over an hour to complete. It was really interesting to see that with larger projects how the level of testing has to be extremely robust to keep code bug free. I think thats what will really stay with me the most from this pull request. Once my checks passed( 2 actually failed but from other pull requests that also had those check fail, I learned this was unrelated to the changes I had made) my request was approved and merged and the developers thanked me. 

Comments

Post a Comment

Popular posts from this blog

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

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