Skip to content

Commit

Permalink
Add final improvements to badges (#21)
Browse files Browse the repository at this point in the history
* Add final improvements to badges

* Add OSS templates

* Remove separation between OpenSSF badges and the other ones
  • Loading branch information
L-Zuluaga authored Feb 7, 2024
1 parent 0086d18 commit 2e14bed
Show file tree
Hide file tree
Showing 5 changed files with 110 additions and 4 deletions.
36 changes: 36 additions & 0 deletions .github/workflows/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
name: 🐞 Bug report
about: Tell us about a bug you found
title: ''
labels: '🐞 Bug, ⛑ Needs triage'
assignees: ''

---

### Precheck

- [ ] Do a quick search and make sure the bug has not been reported yet.
- [ ] Please disclose security vulnerabilities privately at [oss@kommit.co](mailto:oss@kommit.co).
- [ ] Finally, be nice and have fun!.

### Description

A clear and concise description of what the bug is.

### Environment

* Operating system:
* Ruby version:

### Current behavior

Include code samples, errors and stack traces if appropriate.
If reporting a bug, please include the reproducing steps.

### Expected behavior

A clear and concise description of what you expected to happen.

### Additional context

Add any other context about the problem here.
28 changes: 28 additions & 0 deletions .github/workflows/ISSUE_TEMPLATE/epic.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
name: 🎯 Epic
about: Tell us about this new Epic
title: ''
labels: '🎯 Epic'
assignees: ''

---

ℹ️ This issue is an Epic 🎯

## Context

Provides a context about this Epic and tells us, how it should be broken down into smaller implementations.

## Objective

Mention the objective of this Epic.

## Checklist
<!--
This checklist can be taken as the subtasks to solve this Epic.
Whenever possible, mention the related issues.
-->

- [ ] Task 1
- [ ] Task 2
- [ ] ...
20 changes: 20 additions & 0 deletions .github/workflows/ISSUE_TEMPLATE/epic_task.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: 👉 Epic task
about: Describe the task included in an Epic
title: ''
labels: '👍 Feature'
assignees: ''

---

ℹ️ This issue is part of Epic #(epic-issue)

## Objective

Mention the objective of this task included in an Epic.

## Checklist

- [ ] Item 1
- [ ] Item 2
- [ ] ...
24 changes: 24 additions & 0 deletions .github/workflows/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
name: 👋 Feature request
about: Tell us what you'd like to see
title: ''
labels: '👍 Feature, ⛑ Needs triage'
assignees: ''

---

### Is your feature request related to a problem? Please describe.

A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

### Describe the solution you'd like

A clear and concise description of what you want to happen.

### Describe alternatives you've considered

A clear and concise description of any alternative solutions or features you've considered.

### Additional context

Add any other context or screenshots about the feature request here.
6 changes: 2 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,11 @@
The business notification system is designed to be a versatile platform, offering key components for building various use cases. It provides an easy-to-use tool for implementing notifications without excessive complexity.

![Gem Version](https://img.shields.io/gem/v/bns?style=for-the-badge)
![Gem Downloads (for specified version)](https://img.shields.io/gem/dv/bns/0.1.0?style=for-the-badge)
![Gem Total Downloads](https://img.shields.io/gem/dt/bns?style=for-the-badge)
![Build Badge](https://img.shields.io/github/actions/workflow/status/kommitters/bns/ci.yml?branch=project-opensource-config&style=for-the-badge)
[![Coverage Status](https://img.shields.io/coveralls/github/kommitters/bns?style=for-the-badge)](https://coveralls.io/github/kommitters/bns?branch=main)
![GitHub License](https://img.shields.io/github/license/kommitters/bns?style=for-the-badge)


[![OpenSSF Scorecard](https://img.shields.io/ossf-scorecard/github.com/kommitters/bns?style=for-the-badge)](https://api.securityscorecards.dev/projects/github.com/kommitters/bns)
[![OpenSSF Scorecard](https://img.shields.io/ossf-scorecard/github.com/kommitters/bns?label=openssf%20scorecard&style=for-the-badge)](https://api.securityscorecards.dev/projects/github.com/kommitters/bns)
[![OpenSSF Best Practices](https://img.shields.io/cii/summary/8383?label=openssf%20best%20practices&style=for-the-badge)](https://bestpractices.coreinfrastructure.org/projects/8383)

## Installation
Expand Down

0 comments on commit 2e14bed

Please sign in to comment.