#github
Tag

Why don't my markdown titles work sometimes?

Mar 14, 2025 3 minute read #markdown, #github, #obsidian, #hugo, #sphinx, #myst

I write a lot of markdown. I use it on GitHub when creating issues/PRs, I use it in Obsidian when I take notes, I use it in Hugo when writing blog posts (like this one), I use it in Jupyter Notebooks when working with data and I use it in Sphinx with MyST when writing documentation.
Most stale bots are anti-user and anti-contributor, but they don't have to be

Dec 5, 2024 7 minute read #github, #open-source, #projects

If you’ve been around open source projects on GitHub you may have encountered a project with a stale bot.
Creating GitHub Releases automatically on tags

Apr 19, 2024 6 minute read #guide, #github, #github-actions, #release-drafter

GitHub Releases is a feature where you can create a page associated with a git tag that contains a description of the changes in that tag along with build artifacts for users to download.
GitHub streaks and work/life balance

Jan 2, 2024 3 minute read #github, #work/life

I recently read Loving and hating the Streak by Cassidy Williams. The post was all about committing code on GitHub every single day to maintain a streak.
Don't prematurely squash/rebase and force push your PRs

Jul 26, 2022 3 minute read #open-source, #github, #best-practices, #code-review

A big frustration for me when reviewing Pull Requests on GitHub is coming back to a PR you’ve already reviewed to check on recent changes and be greeted with “We went looking everywhere, but couldn’t find those commits”.
Branding your open source Python package

Jul 9, 2021 12 minute read #python, #github, #tutorial

Having a brand can help give your open source project some legitimacy, and you don’t need to be a designer to see these benefits. However it is important to understand that you do not need to add branding to your project in order for it to be successful, and adding branding can even harm your project.
Building a contributor community for your open source project

Apr 30, 2021 10 minute read #python, #github, #tutorial

With our open source project published on GitHub we probably want to allow folks to contribute changes. Some users of the project may find bugs, or desire extra features and will open issues to tell you. Users who have the skills required to make that change can open a Pull Request on GitHub to propose it. As the maintainer you can then review and merge those changes.
Communicating with your open source community

Apr 23, 2021 7 minute read #python, #github, #tutorial

Once your open source Python project has users and a community you will likely want to communicate with them in an official capacity. Perhaps you want to tell them about a new release, show a use case where someone is using your tool or solicit feedback on an upcoming feature.
Building a user community for your open source project

Apr 16, 2021 11 minute read #python, #github, #tutorial

Now that our open source Python project exists and users can install it we will want to turn our attention to sustainability, reach and ongoing maintenance. By putting it out there and gaining users you are opening yourself up to questions, bug reports and feature requests.
Documenting Python projects with Sphinx and Read the Docs

Apr 9, 2021 7 minute read #python, #github, #tutorial

In part four of this series we discussed documenting our code as we went along by adding docstrings throughout out project. In this post we will see that effort pay off by building a documentation site using Sphinx which will leverage all of our existing docstrings.
Automating releases of Python packages with GitHub Actions

Mar 26, 2021 7 minute read #python, #github, #tutorial

In this post we will cover automatically packaging and releasing our project when a new git tag is pushed to GitHub.
Testing and Continuous Integration for Python packages with GitHub Actions

Mar 19, 2021 10 minute read #python, #github, #tutorial

In this post we will cover automatically running our tests when we push new code to GitHub, and when contributors raise Pull Requests against our project.
Test driven development in Python

Mar 12, 2021 7 minute read #python, #github, #tutorial

What is test driven development (TDD)?

Test driven development is a style of development where you write your tests before you write your code.
Testing your Python package

Jan 22, 2021 7 minute read #python, #github, #tutorial

In this post we will cover testing our code.

Testing

There are many many great resources out there for learning about testing software. In this post I’m going to try and focus on simple examples that you can use to get started quickly. Once you have a good foundation for your tests you can then dive into mocking, replaying HTTP requests or even hypothesis testing.
Documenting your Python code

Jan 15, 2021 4 minute read #python, #github, #tutorial

This post will cover documenting our code. Specifically adding documentation within the code itself.

Docstrings

Right now our code is undocumented, so if the user inspects our function they will only see the interface (the way you call it) but with no other context. We can use IPython to quickly inspect this.
Publishing open source Python packages on GitHub, PyPI and Conda Forge

Feb 28, 2020 10 minute read #python, #github, #tutorial, #packaging, #pypi, #conda-forge, #anaconda

In this post we will cover making our code available to people. This is the bit where we open the source! We will push our code to a code posting platform and then package up our library and submit it to a couple of repositories to make it easy for people to install.
Versioning and formatting your Python code

Feb 14, 2020 8 minute read #python, #github, #tutorial, #black, #versioneer, #semver

In this post, we will cover a few project hygiene things that we may want to put into place to make our lives easier in the future.
Testing static sites with Lighthouse CI and GitHub Actions

Feb 13, 2020 7 minute read #python, #github, #tutorial, #github-actions, #static-sites, #lighthouse-ci

When you build a website you want pages to load as quickly as possible for users. Google has a tool called PageSpeed Insights which you can run on your website to see various metrics about the page. I’ve used it in the past while working on my blog and other sites.
Creating an open source Python project from scratch

Feb 7, 2020 9 minute read #python, #github, #tutorial, #git, #oss-licensing

Have you had a great idea for an open-source Python library that you think people will find useful, but you don’t know where to begin in creating and publishing it?
Generate git release notes automatically

Jun 15, 2017 2 minute read #git, #github

It is common practice for release notes to consist of a list of the Pull Requests which have been merged since the last release. Some projects divide these into categories, for example breaking changes, enhancements and bug fixes. If you are a project maintainer you may want to be able to generate this automatically.
Collaborative article corrections in Jekyll

May 27, 2015 2 minute read #jekyll, #github, #collaboration

Don’t you find it really useful when you publish an article on your blog and then someone comes up to you and says:
Test your Jekyll blog with Travis CI

Feb 18, 2015 5 minute read #jekyll, #unit-test, #travis-ci, #github

Introduction

Testing your blog may sound like an odd thing to do, but if you’re running a Jekyll blog hosted on GitHub it is simple to set up and really useful for notifying you about broken links and other issues.
Mac OS X Terminal Theme: Piperita

Oct 17, 2013 1 minute read #bash, #github, #terminal, #theme

UPDATE – This project is now at version 2. See the Piperita GitHub page for up to date documentation and information.

#github Tag

What is test driven development (TDD)?

Testing

Docstrings

Introduction

#github
Tag