alestiago / issues

Collection of minimal reproductive code samples that aim to resolve issues.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Issues

This repository stores reproductive samples of issues present in different codebases. Reproductive samples are stored in branches.

πŸ‘¨β€πŸ’» Trying it out

To try an issue out I recommend:

# πŸ§ͺ Cloning the repository
git clone https://github.com/alestiago/issues.git

# πŸͺ΅ Checking the branch you're interested in
git checkout <branch-name>

# πŸ“– Reading the README.md of the branch for further instructions
open README.md

πŸͺ΅ Branch naming convention

Branches follow the naming convention:

<codebase-name>-<issue-number>-YYYYMMDD

Where:

  • <codebase-name> is the name of the GitHub repository that stores the tested codebase.
  • <issue-number> is the number of the GitHub issue that links to the problem.
  • YYYYMMDD is the date where the issue was first reproduced in the sample.

For example:

  • very_good_cli-648-20230220 is a valid name. Where the GitHub repository is very_good_cli, the issue is 648 and the first date where the sample reproduced the issue was the 20th of February, 2023.

Note: If a particular sample doesn't have a matching issue yet, the branch is named with a leading underscore and the <issue-number> is a brief description of its aim.

About

Collection of minimal reproductive code samples that aim to resolve issues.