Skip to content

Latest commit

 

History

History
45 lines (27 loc) · 1.78 KB

README.md

File metadata and controls

45 lines (27 loc) · 1.78 KB

My OSS Contribution

  • I found TemPy via Up for Grabs, one of the sites suggested by Katrina Owen.
  • I chose this project for its familiar and relatively simple code as well as its openness to small, basic contributions.
  • It's a very active project - the latest commit was less than a day from the time of my typing here.
  • After running a sample code from the readme, I decided to contribute by editing that part of the readme such that the given code and expected output more correctly matched.

Before creating and cloning the fork:

cloned fork

I copied the sample code for "basic usage" to test on IDLE, a Python 3.6 editor:

sample code test

TemPy did not render the HTML as shown in the readme:

actual render

So I modified my copy to better reflect the expected output:

updated code

The updated code successfully rendered all the correct HTML tags in the desired order...

new render

but getting it to render them in the structured format remained a mystery.

Still, it was enough of an improvement for me to proceed. I created and switched to a local branch,

readme-edit branch switch

found the section, before

applied my changes, after

committed, and pushed to my fork on GitHub: commit

With a readme that now has what should be a more accurate usage example, I made a pull request.