Skip to content
This repository has been archived by the owner on Jan 29, 2020. It is now read-only.

Commit

Permalink
🏑🚐 move conventional-changelog-emoji to its own repo
Browse files Browse the repository at this point in the history
  • Loading branch information
tim-evans committed Oct 31, 2019
1 parent 6be3921 commit 3a2fe42
Show file tree
Hide file tree
Showing 21 changed files with 7,845 additions and 0 deletions.
7 changes: 7 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
coverage
dist
node_modules
tmp
*.log
.*.swp
.cache
11 changes: 11 additions & 0 deletions .npmignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
.cache
.vscode
dist/**/test
dist/**/node_modules
src
public
test
tmp
.npmrc
tsconfig.json
tslint.json
1 change: 1 addition & 0 deletions .npmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
package-lock=false
1 change: 1 addition & 0 deletions .nvmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
8.16.2
10 changes: 10 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
language: node_js
node_js:
- "8"

install:
- npm ci

script:
- npm test -- --no-cache --coverage --maxWorkers=4
44 changes: 44 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
# Change Log

All notable changes to this project will be documented in this file.
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.

## [0.19.0](https://github.com/CondeNast-Copilot/atjson/compare/@atjson/conventional-changelog-emoji@0.17.0...@atjson/conventional-changelog-emoji@0.19.0) (2019-08-05)

### πŸ”’ Security Updates

- πŸ”’ fix security audits

## [0.17.0](https://github.com/CondeNast-Copilot/atjson/compare/@atjson/conventional-changelog-emoji@0.10.0...@atjson/conventional-changelog-emoji@0.17.0) (2019-07-10)

### πŸ› Fixes

- 🐞 Fix references to wrong github repository ([#135](https://github.com/CondeNast-Copilot/atjson/issues/135))

## [0.10.0](https://github.com/CondeNast/atjson/compare/@atjson/conventional-changelog-emoji@0.9.1...@atjson/conventional-changelog-emoji@0.10.0) (2019-01-09)

### ✨ New Features

- πŸŽ‰ Add more bug emoji

## [0.9.1](https://github.com/CondeNast/atjson/compare/@atjson/conventional-changelog-emoji@0.9.0...@atjson/conventional-changelog-emoji@0.9.1) (2018-12-11)

**Note:** Version bump only for package @atjson/conventional-changelog-emoji

## [0.9.0](https://github.com/CondeNast/atjson/compare/@atjson/conventional-changelog-emoji@0.8.7...@atjson/conventional-changelog-emoji@0.9.0) (2018-10-10)

**Note:** Version bump only for package @atjson/conventional-changelog-emoji

## [0.8.7](https://github.com/CondeNast/atjson/compare/@atjson/conventional-changelog-emoji@0.8.6...@atjson/conventional-changelog-emoji@0.8.7) (2018-09-14)

**Note:** Version bump only for package @atjson/conventional-changelog-emoji

## [0.8.6](https://github.com/CondeNast/atjson/compare/@atjson/conventional-changelog-emoji@0.8.5...@atjson/conventional-changelog-emoji@0.8.6) (2018-09-04)

### πŸ› Fixes

- πŸ›πŸ”’ fix vulnerability with with git-dummy-commit by using shelljs directly ([#76](https://github.com/CondeNast/atjson/issues/76))

## 0.8.5 (2018-08-02)

**Note:** Version bump only for package @atjson/conventional-changelog-emoji
76 changes: 76 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
# Contributor Covenant Code of Conduct

## Our Pledge

In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to make participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, sex characteristics, gender identity and expression,
level of experience, education, socio-economic status, nationality, personal
appearance, race, religion, or sexual identity and orientation.

## Our Standards

Examples of behavior that contributes to creating a positive environment
include:

- Using welcoming and inclusive language
- Being respectful of differing viewpoints and experiences
- Gracefully accepting constructive criticism
- Focusing on what is best for the community
- Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

- The use of sexualized language or imagery and unwelcome sexual attention or
advances
- Trolling, insulting/derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or electronic
address, without explicit permission
- Other conduct which could reasonably be considered inappropriate in a
professional setting

## Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable
behavior and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or
reject comments, commits, code, wiki edits, issues, and other contributions
that are not aligned to this Code of Conduct, or to ban temporarily or
permanently any contributor for other behaviors that they deem inappropriate,
threatening, offensive, or harmful.

## Scope

This Code of Conduct applies within all project spaces, and it also applies when
an individual is representing the project or its community in public spaces.
Examples of representing a project or community include using an official
project e-mail address, posting via an official social media account, or acting
as an appointed representative at an online or offline event. Representation of
a project may be further defined and clarified by project maintainers.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at [INSERT EMAIL ADDRESS]. All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good
faith may face temporary or permanent repercussions as determined by other
members of the project's leadership.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

[homepage]: https://www.contributor-covenant.org

For answers to common questions about this code of conduct, see
https://www.contributor-covenant.org/faq
81 changes: 81 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
# ✌️ conventional-changelog-emoji

[Conventional Commits](https://conventionalcommits.org/) is a community standard designed to generate software changes automatically.

We use emoji for our conventional commits to reduce technical jargon in our software.

Commits look like `✌️ My awesome change (#12)`. There’s emoji at the beginning, the description of the changes made in the middle and the number referencing the GitHub pull request at the end.

## 🧩 Install

```bash
npm install @atjson/conventional-changelog-emoji
```

### ❀️ Supported emoji

| Emoji | Changelog Heading | Severity | Included in Changelog? |
| ----- | -------------------- | -------- | ---------------------- |
| πŸ— | πŸ— Build Changes | patch | 🚫 |
| πŸ“¦ | πŸ“¦ npm changes | patch | 🚫 |
| 🚨 | 🚨 Breaking Changes | breaking | βœ… |
| πŸ‘·β€β™€οΈ | πŸ‘·β€β™€οΈ TravisCI | patch | 🚫 |
| πŸ‘·β€β™‚οΈ | πŸ‘·β€β™‚οΈ TravisCI | patch | 🚫 |
| πŸ—» | πŸ—» CodeClimate | patch | 🚫 |
| πŸ‘©β€βš–οΈ | βš–οΈ Licensing Changes | major | βœ… |
| πŸ‘¨β€βš–οΈ | βš–οΈ Licensing Changes | major | βœ… |
| βš–οΈ | βš–οΈ Licensing Changes | major | βœ… |
| πŸ““ | πŸ“š Documentation | patch | 🚫 |
| πŸ“š | πŸ“š Documentation | patch | 🚫 |
| ✨ | ✨ New Features | minor | βœ… |
| πŸŽ‰ | ✨ New Features | minor | βœ… |
| 🎊 | ✨ New Features | minor | βœ… |
| πŸ› | πŸ› Fixes | patch | βœ… |
| 🐝 | πŸ› Fixes | patch | βœ… |
| πŸ”’ | πŸ”’ Security Updates | patch | βœ… |
| πŸš€ | πŸš€ Performance | patch | 🚫 |
| πŸ›€ | πŸ›€ Code Cleanup | patch | 🚫 |
| βͺ | βͺ Undo Changes | revert | 🚫 |
| πŸ’… | πŸ’„ Style | patch | 🚫 |
| πŸ’„ | πŸ’„ Style | patch | 🚫 |
| 🎨 | πŸ’„ Style | patch | 🚫 |
| 🚦 | 🚦 Tests | patch | 🚫 |
| πŸš₯ | 🚦 Tests | patch | 🚫 |

<small>PS: Use any skin tone you want– we'll detect it regardless of the skin tone and put it under the correct heading 😘</small>

### πŸ™‹β€β™€οΈ Do you have an emoji that you'd like to add?

Add your emoji to [this spreadsheet](https://github.com/CondeNast/conventional-changelog-emoji/tree/latest/src/emoji.csv) with the heading that it should live under, the severity of the change, and a 🚫 or βœ… indicating whether it should be included in the changelog.

The severity can be one of the following:

- `patch` indicates fixes and other changes
- `minor` indicates new features (and possibly fixes as well)
- `major` / `breaking` indicates that the software now works differently and will need to be updated accordingly

### πŸ‘‰ Examples

Let’s use the commit examples used above:

- πŸ“¦ Release 0.2.8
- πŸ› Fix nested bold and italic markdown output ([#32](https://github.com/CondeNast/atjson/issues/24))
- πŸŽ‰ Add horizontal rule and vertical adjustments for Google Docs paste ([#52](https://github.com/CondeNast/atjson/issues/52))
- βœ¨πŸ‘‘βœ¨ Make Annotations classes instead of JS objects ([#54](<](https://github.com/CondeNast/atjson/issues/54)>))\
\
🚨 Schemas are now defined as a list of annotation classes, cf. `[Bold, Italic]`

And show what will be our changelog!

### πŸ› Fixes

- πŸ› Fix nested bold and italic markdown output ([#32](https://github.com/CondeNast/atjson/issues/24))

### ✨ New Features

- βœ¨πŸ‘‘βœ¨ Make Annotations classes instead of JS objects ([#54](<](https://github.com/CondeNast/atjson/issues/54)>))
- πŸŽ‰ Add horizontal rule and vertical adjustments for Google Docs paste ([#52](https://github.com/CondeNast/atjson/issues/52))

### 🚨 Breaking Changes

- Schemas are now defined as a list of annotation classes, cf. `[Bold, Italic]`
23 changes: 23 additions & 0 deletions index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
"use strict";

const Q = require("q");
const conventionalChangelog = require("./src/conventional-changelog");
const parserOpts = require("./src/parser-opts");
const recommendedBumpOpts = require("./src/conventional-recommended-bump");
const writerOpts = require("./src/writer-opts");

module.exports = Q.all([
conventionalChangelog,
parserOpts,
recommendedBumpOpts,
writerOpts
]).spread(
(conventionalChangelog, parserOpts, recommendedBumpOpts, writerOpts) => {
return {
conventionalChangelog,
parserOpts,
recommendedBumpOpts,
writerOpts
};
}
);
Loading

0 comments on commit 3a2fe42

Please sign in to comment.