Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/alestiago/issues

Collection of minimal reproductive code samples that aim to resolve issues.
https://github.com/alestiago/issues

Last synced: 5 days ago
JSON representation

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

Awesome Lists containing this project

README

        

# 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:

```sh
# ๐Ÿงช Cloning the repository
git clone https://github.com/alestiago/issues.git

# ๐Ÿชต Checking the branch you're interested in
git checkout

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

## ๐Ÿชต Branch naming convention

Branches follow the naming convention:

```
--YYYYMMDD
```

Where:

- `` is the name of the GitHub repository that stores the tested codebase.
- `` 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](https://github.com/VeryGoodOpenSource/very_good_cli), the issue is [648](https://github.com/VeryGoodOpenSource/very_good_cli/issues/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 `` is a brief description of its aim.