Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings

Commit 3f74209

Browse files
style: add badges
1 parent 5339a27 commit 3f74209

File tree

2 files changed

+33
-3
lines changed

2 files changed

+33
-3
lines changed

‎CONTRIBUTING.md‎

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,6 +104,16 @@ format that includes a **type**, a **scope** and a **subject**:
104104
<footer>
105105
```
106106
107+
Example of a commit with header, body and footer:
108+
109+
```
110+
fix(linked-list): insert in the middle bug
111+
112+
When inserting an item on the middle of a linked list one reference was not being updated properly.
113+
114+
Fixes: #8
115+
```
116+
107117
The **header** is mandatory and the **scope** of the header is optional.
108118
109119
Any line of the commit message cannot be longer 100 characters! This allows the message to be easier
@@ -168,7 +178,16 @@ reference GitHub issues that this commit **Closes**.
168178
Closes #234
169179
```
170180

171-
**Breaking Changes** should start with the word `BREAKING CHANGE:` with a space or two newlines. The rest of the commit message is then used for this.
181+
**Breaking Changes** should start with the word `BREAKING CHANGE:` on the footer with a space or two newlines. The rest of the commit message is then used for this.
182+
183+
Examples of breaking changes include:
184+
185+
* removal or redefinition of existing API arguments
186+
* changing return values
187+
* removing or modifying existing properties on an options argument
188+
* adding or removing errors
189+
* altering expected timing of an event
190+
* changing the side effects of using a particular API
172191

173192

174193
## Generating Changelog
@@ -194,3 +213,8 @@ git log 1.2.0..HEAD --pretty=format:"- %s [commit](https://github.com/amejiarosa
194213
git log 1.2.0..HEAD --pretty=format:"- %s [commit](https://github.com/amejiarosario/dsa.js/commit/%H)" --grep "^feat\S*:"
195214
git log 1.2.0..HEAD --pretty=format:"- %s [commit](https://github.com/amejiarosario/dsa.js/commit/%H)" --grep "^fix\S*:"
196215
```
216+
217+
218+
<!-- Examples -->
219+
<!-- https://github.com/nodejs/node/blob/v12.0.0/COLLABORATOR_GUIDE.md -->
220+
<!-- https://github.com/nodejs/node/blob/v12.0.0/doc/guides/writing-and-running-benchmarks.md -->

‎README.md‎

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,13 @@
11
# Data Structures and Algorithms in JavaScript
22

3-
[![Build Status](https://travis-ci.com/amejiarosario/dsa.js.svg?branch=master)](https://travis-ci.com/amejiarosario/dsa.js)
4-
[![npm version](https://badge.fury.io/js/dsa.js.svg)](https://badge.fury.io/js/dsa.js)
3+
[![Build Status](https://travis-ci.com/amejiarosario/dsa.js.svg?branch=master)](https://travis-ci.com/amejiarosario/dsa.js) [![NPM version](https://badge.fury.io/js/dsa.js.svg)](https://badge.fury.io/js/dsa.js) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](http://makeapullrequest.com) [![Code Style Airbnb](https://img.shields.io/badge/code%20style-Airbnb-brightgreen.svg)](https://github.com/airbnb/javascript)
4+
[![ProductHunt](https://img.shields.io/badge/product%20hunt-vote-orange.svg)](https://www.producthunt.com/posts/dsa-js)
5+
6+
<!--
7+
https://bundlephobia.com/result?p=dsa.js
8+
https://img.shields.io/bundlephobia/min/dsa.js.svg - 16.7kB
9+
https://img.shields.io/github/repo-size/amejiarosario/dsa.js.svg - 98.1 MB
10+
-->
511

612
This repository covers the implementation of the classical algorithms and data structures in JavaScript.
713

0 commit comments

Comments
(0)

AltStyle によって変換されたページ (->オリジナル) /