Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

package @frontity/error README.md full standard #464

Merged
merged 10 commits into from
Jun 10, 2020
Merged

Conversation

juanmaguitar
Copy link
Member

What:

Adding README.md's of error package

Why:

So it has the proper info in NPM

How:

Creating the README.md's using on the proper folder

npx readme-md-generator -p ../../.github/README_TEMPLATE/package-readme.md -y

And then adding custom info on each README.md

Tasks:

Unrelated Tasks

  • Code
  • TSDocs
  • TypeScript
  • Unit tests
  • End to end tests
  • TypeScript tests
  • Update starter themes
  • Update other packages
  • Link to PR in Documentation
  • Community discussions
  • Changeset (with link to its Feature Discussion if it exists)

Additional Comments

@changeset-bot
Copy link

changeset-bot bot commented Jun 5, 2020

🦋 Changeset is good to go

Latest commit: 9c2fc28

We got this.

This PR includes changesets to release 1 package
Name Type
@frontity/error Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@codecov
Copy link

codecov bot commented Jun 5, 2020

Codecov Report

Merging #464 into dev will not change coverage.
The diff coverage is n/a.

Copy link
Member

@luisherranz luisherranz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • This package is not meant to be installed individually, it comes within "frontity".
  • Their tools are not meant to be used by importing from the package, but instead from "frontity".
import { warn, error } from "frontity";
...
warn("Warning: myMethod() is being used in a non ... ");
...

…r-README

* 'error-README' of github.com:frontity/frontity:
  Add robots to mars-theme-example now.json
  improved install version
  Change bump to a patch
  Change bump to patch
  changeset
  changeset
  frontity/README.md
  comscore-analytics/README.md
Copy link
Member

@luisherranz luisherranz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @juanmaguitar 👍

@michalczaplinski michalczaplinski merged commit 2d6d0fc into dev Jun 10, 2020
@michalczaplinski michalczaplinski deleted the error-README branch June 10, 2020 02:03
@github-actions github-actions bot mentioned this pull request Jun 19, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants