https://github.com/dominique-mueller/my-open-source-setup

My personal setup for Open Source projects on Github.
https://github.com/dominique-mueller/my-open-source-setup

github opensource preset setup starter template

Last synced: 11 days ago
JSON representation

My personal setup for Open Source projects on Github.

• Host: GitHub
• URL: https://github.com/dominique-mueller/my-open-source-setup
• Owner: dominique-mueller
• Created: 2017-03-29T20:00:36.000Z (almost 8 years ago)
• Default Branch: main
• Last Pushed: 2021-04-28T16:15:21.000Z (over 3 years ago)
• Last Synced: 2024-11-10T15:51:12.313Z (2 months ago)
• Topics: github, opensource, preset, setup, starter, template
• Homepage:
• Size: 212 KB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• jimsghstars - dominique-mueller/my-open-source-setup - My personal setup for Open Source projects on Github. (Others)

README

        


# Open Source Project Starter

My personal setup for Open Source projects on Github.







## GitHub Labels

In GitHub, we can assign labels to both issues and pull requests in order to signify their priority, category, or just assign any other

useful information. This makes understanding and organizing issues much easier, especially for bigger projects. This repository comes with a

basic label preset, placed within the `github-labels.json` file.

![GitHub Labels Preview](/docs/github-labels-preview.png?raw=true)

### Setup

The following describes how to quickly setup my personal list of labels.

> **WARNING**:
This process clears all existing labels, thus also unassigning labels from all issues and pull requests! For existing

> projects, it's better to just create / update / delete the labels manually.

1. Install **[GitHub Label Template](https://github.com/xavierchow/github-label-template)** globally by running:

```bash

npm install -g github-label-template

```

2. Using this tool requires a **GitHub access token**. To generate one, visit the GitHub

   **[Personal Access Tokens](https://github.com/settings/tokens)** page, generate a new token (at least `repo -> public_repo` must be

   enabled) with a meaningful title, hit _Generate Token_, and copy the result.

3. Now, clear all existing labels by running:

```bash

ghlbl -o  -r  -t  -d

```

4. Then, import the label template by running:

```bash

ghlbl -o  -r  -t  -i ./presets/github-labels.json

```






## [Codecov](https://codecov.io/)

Codecov allows us to track code coverage over time, and it also comes with a bot that writes comments into Pull Requests presenting the

current code coverage and its change compared to the default branch.

![Codecov Preview](/docs/codecov-preview.png?raw=true)

> I've also tested **[Coveralls](https://coveralls.io/)**, but it wasn't very stable in my experience.

### Setup

1. Add the **[codecov](https://www.npmjs.com/package/codecov)** to the `devDependencies` of your project's `package.json` file. For example:

```json

{

  "devDependencies": {

    "codecov": "x.x.x"

  }

}

```

2. Add a code coverage upload script to your `package.json` file. For example:

```json

{

  "test:upload-coverage": "codecov -f coverage/coverage-final.json"

}

```

3. Add a `codecov.yml` configuration file to your project with your preferred configuration.

> My custom configuration can be found at `presets/codecov.yml`.

4. Run the script to your CI, after your tests have finished successfully. In GitHub actions, for example:

```yml

jobs:

  test:

    name: Test

    steps:

      # Other steps ...

      - name: Upload test coverage

        run: npm run test:upload-coverage

```