Skip to content

Commit

Permalink
chore: rename to match org
Browse files Browse the repository at this point in the history
  • Loading branch information
Newton Koumantzelis committed Mar 25, 2020
1 parent d4ee02f commit fefba03
Show file tree
Hide file tree
Showing 10 changed files with 53 additions and 54 deletions.
10 changes: 5 additions & 5 deletions .github/MAINTAINING.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Sometimes, the `support` label will be added to things that turn out to actually

In order to help other folks out with their questions:

* Go to the issue tracker and [filter open issues by the `support` label](https://github.com/the-holocron/browserslist-average-usage/issues?q=is%3Aopen+is%3Aissue+label%3Asupport).
* Go to the issue tracker and [filter open issues by the `support` label](https://github.com/the-holocron/browserslist-median-usage/issues?q=is%3Aopen+is%3Aissue+label%3Asupport).
* Read through the list until you find something that you're familiar enough with to give an answer.
* Respond to the issue with whatever details are needed to clarify the question, or get more details about what's going on.
* Once the discussion wraps up and things are clarified, either close the issue, or ask the original issue filer (or a maintainer) to close it for you.
Expand All @@ -47,7 +47,7 @@ Some notes on picking up support issues:

One of the most important tasks in handling issues is labeling them usefully and accurately. All other tasks involving issues ultimately rely on the issue being classified in such a way that relevant parties looking to do their own tasks can find them quickly and easily.

In order to label issues, [open up the list of unlabeled issues](https://github.com/the-holocron/browserslist-average-usage/issues?q=is%3Aopen+is%3Aissue+no%3Alabel) and, **from newest to oldest**, read through each one and apply issue labels according to the table below. If you're unsure about what label to apply, skip the issue and try the next one: don't feel obligated to label each and every issue yourself!
In order to label issues, [open up the list of unlabeled issues](https://github.com/the-holocron/browserslist-median-usage/issues?q=is%3Aopen+is%3Aissue+no%3Alabel) and, **from newest to oldest**, read through each one and apply issue labels according to the table below. If you're unsure about what label to apply, skip the issue and try the next one: don't feel obligated to label each and every issue yourself!

Label | Apply When | Notes
--- | --- | ---
Expand Down Expand Up @@ -80,15 +80,15 @@ To clean up issues and PRs:
* not marked as `good first issue` or `help wanted` (these might stick around for a while, in general, as they're intended to be available)
* no explicit messages in the comments asking for it to be left open
* does not belong to a milestone
* Leave a message when closing saying "Cleaning up stale issue. Please reopen or ping us if and when you're ready to resume this. See https://github.com/the-holocron/browserslist-average-usage/blob/latest/MAINTAINING.md#clean-up-issues-and-prs for more details."
* Leave a message when closing saying "Cleaning up stale issue. Please reopen or ping us if and when you're ready to resume this. See https://github.com/the-holocron/browserslist-median-usage/blob/latest/MAINTAINING.md#clean-up-issues-and-prs for more details."

## Create a Pull Request

If you're unfamiliar with the Github flow, please [read this guide](https://guides.github.com/introduction/flow/index.html) as an introduction. Make sure you reach out to someone on the team before you start any work to ensure that what you're doing is aligned with the teams' vision. Read Ilya Grigorik's great article [Don't "Push" Your Pull Requests](https://www.igvita.com/2011/12/19/dont-push-your-pull-requests/). The following passage sums up some great points:

> Contributions are always welcome, but surprise patches are mostly just a burden. Yes, you are offering your help, but someone else will have to maintain your code over the long term - get their buy-in first, avoid surprises. Even worse, a localized change to address a specific problem will often miss the full implications to the project: other existing use cases, future roadmap plans, or overall architectural decisions. A good idea can be implemented inappropriately for the specific project; it can be invalidated by another effort that you may not even be aware of; the timing may be wrong, and a dozen other reasons can conspire against you.
1. Clone the repo (`git clone https://github.com/the-holocron/browserslist-average-usage`)
1. Clone the repo (`git clone https://github.com/the-holocron/browserslist-median-usage`)
2. If you've cloned previously, then get latest changes (`git checkout master; git pull origin master`).
3. Create your feature branch (`git checkout -b <my-new-feature>`); checkout the
guide below for our branching strategy.
Expand Down Expand Up @@ -205,6 +205,6 @@ If you want to verify that the release will match the above rules then run a dry

**Permission Required**: [Owner](./CONTRIBUTING.md#permissions)

Once a version has been determined, run `npm run release`. This will update the `version` key within the [package.json](https://github.com/the-holocron/browserslist-average-usage/blob/master/package.json#L5) and the [package-lock.json](https://github.com/the-holocron/browserslist-average-usage/blob/master/package-lock.json#L3), as well as generate the [CHANGELOG](../CHANGELOG.md), commit using our conventions and create the tag. **DO NOT USE the `npm version` command!**
Once a version has been determined, run `npm run release`. This will update the `version` key within the [package.json](https://github.com/the-holocron/browserslist-median-usage/blob/master/package.json#L5) and the [package-lock.json](https://github.com/the-holocron/browserslist-median-usage/blob/master/package-lock.json#L3), as well as generate the [CHANGELOG](../CHANGELOG.md), commit using our conventions and create the tag. **DO NOT USE the `npm version` command!**

After running the script, the next step is to push to the remote using the following command: `git push --follow-tags origin master`
8 changes: 4 additions & 4 deletions .github/SUPPORT.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@

If you have a question about this project, how to use it, or need clarification about something:

1. Open a [support request](https://github.com/the-holocron/browserslist-average-usage/issues/new?template=support_request.md) or reach out via [email](mailto:holocron77@gmail.com).
1. Open a [support request](https://github.com/the-holocron/browserslist-median-usage/issues/new?template=support_request.md) or reach out via [email](mailto:holocron77@gmail.com).
2. Provide as much context as you can about what you're running into.
3. Provide browser, library and/or platform versions (`nodejs`, `npm`, etc), depending on what seems relevant. If not, please be ready to provide that information if maintainers ask for it.

Expand Down Expand Up @@ -46,23 +46,23 @@ Spending the extra time up front can help save everyone time in the long run.

If you run into an error or bug with the project:

1. Open a [bug report](https://github.com/the-holocron/browserslist-average-usage/issues/new?template=bug_report.md)
1. Open a [bug report](https://github.com/the-holocron/browserslist-median-usage/issues/new?template=bug_report.md)
2. Fill out the template and provide as much context as you can about what you're running into and be sure to include steps **to reproduce** such that someone else can follow to recreate the bug or error on their own.
4. Provide project and platform versions (`nodejs`, `npm`, etc), depending on what seems relevant. If not, please be ready to provide that information if maintainers ask for it.

Once it's filed:

* The team will [label the issue](./CONTRIBUTING.md#label-issues).
* A team member will try to reproduce the issue with your provided steps. If there are no obvious ways to reproduce the issue, the team will ask you for those steps and mark the issue as `needs-clarification`. Bugs with the `needs-clarification` tag will not be addressed until they are reproduced.
* If the team is able to reproduce the issue, it will be marked `fix`, as well as possibly other tags (such as `critical`), and the issue will be left to be [implemented by someone](https://github.com/the-holocron/browserslist-average-usage/graphs/contributors).
* If the team is able to reproduce the issue, it will be marked `fix`, as well as possibly other tags (such as `critical`), and the issue will be left to be [implemented by someone](https://github.com/the-holocron/browserslist-median-usage/graphs/contributors).
* If you or the maintainers don't respond to an issue for 30 days, the [issue will be closed](./MAINTAINING.md#clean-up-issues-and-prs). If you want to come back to it, reply (once, please), and we'll reopen the existing issue. Please avoid filing new issues as extensions of one you already made.
* `critical` issues may be left open, depending on perceived immediacy and severity, even past the 30 day deadline.

## Request a Feature

If the project doesn't do something you need or want it to do:

1. Open a [feature request](https://github.com/the-holocron/browserslist-average-usage/issues/new?template=feature_request.md)
1. Open a [feature request](https://github.com/the-holocron/browserslist-median-usage/issues/new?template=feature_request.md)
2. Fill out the template and provide as much context as you can about what you're running into.
3. Please try and be clear about why existing features and alternatives would not work for you.

Expand Down
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Browserslist Average Usage
# Browserslist Median Usage

[![npm](https://img.shields.io/npm/v/@theholocron/browserslist-average-usage?color=red)](https://www.npmjs.com/package/@theholocron/browserslist-average-usage) [![Build Status](https://github.com/the-holocron/browserslist-average-usage/workflows/CI/badge.svg)](https://github.com/the-holocron/browserslist-average-usage/actions?workflow=CI) [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release) [![Dependabot Status](https://api.dependabot.com/badges/status?host=github&repo=the-holocron/browserslist-average-usage)](https://dependabot.com)
[![npm](https://img.shields.io/npm/v/@theholocron/browserslist-median-usage?color=red)](https://www.npmjs.com/package/@theholocron/browserslist-median-usage) [![Build Status](https://github.com/the-holocron/browserslist-median-usage/workflows/CI/badge.svg)](https://github.com/the-holocron/browserslist-median-usage/actions?workflow=CI) [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release) [![Dependabot Status](https://api.dependabot.com/badges/status?host=github&repo=the-holocron/browserslist-median-usage)](https://dependabot.com)

A command-line client that calculates the median level of browser usage based on custom stats in order to take advantage of [Browserslist custom usage](https://github.com/browserslist/browserslist#custom-usage-data) feature.

Expand All @@ -9,7 +9,7 @@ When building out custom usage data, often times the statistics you'll receive f
## Installation

```bash
npm install --save @theholocron/browserslist-average-usage
npm install --save @theholocron/browserslist-median-usage
```

## Table of Contents
Expand All @@ -27,22 +27,22 @@ npm install --save @theholocron/browserslist-average-usage
Run the `--help` or `-h` command to find out how to use the command.

```
$ browserslist-average-usage --help
Usage: browserslist-average-usage [options]
$ browserslist-median-usage --help
Usage: browserslist-median-usage [options]
Options:
--verbose Turn on the logging [boolean]
-h, --help Show help [boolean]
-v, --version Show version number [boolean]
Commands:
browserslist-average-usage Calculates the median level of browser usage based on custom [aliases: get get-average] [default]
browserslist-median-usage Calculates the median level of browser usage based on custom [aliases: get get-median] [default]
stats in order to take advantage of Browserslist custom usage
browserslist-average-usage write [source] Writes to a source of ones choosing of where to store the [aliases: write-file]
average usage statistics
browserslist-median-usage write [source] Writes to a source of ones choosing of where to store the [aliases: write-file]
median usage statistics
Examples:
browserslist-average-usage
browserslist-median-usage
© 2020 The Holocron. All rights reserved.
```
Expand All @@ -53,17 +53,17 @@ At this time, the client does not accept any input.

### Return

If the command succeeds, it will exit with a 0 code and the average percentage of browsers (e.g. `0.03030739465585173`). Otherwise, it will exit with 1 code and an error message.
If the command succeeds, it will exit with a 0 code and the median percentage of browsers (e.g. `0.03030739465585173`). Otherwise, it will exit with 1 code and an error message.

### Commands

#### `get`

This is the default command and doesn't require that you add `get`, as its only an alias. Looks for a `browserlist-stats.json` file at the root of the library or code and calculates the average, then outputs to `stdout`.
This is the default command and doesn't require that you add `get`, as its only an alias. Looks for a `browserlist-stats.json` file at the root of the library or code and calculates the median, then outputs to `stdout`.

#### `write [source]`

Grabs the average and writes the statistics to a source using the string `<percentage> in my stats`. If the stats exist in the source, then it will update the value with the new statistics.
Grabs the median and writes the statistics to a source using the string `<percentage> in my stats`. If the stats exist in the source, then it will update the value with the new statistics.

The source can be one of two types: `package` or `config`. For the package option, it will create or update the `browserslist` key within the `package.json`. For the config option, it will create or update a `browserslistrc.json` file for use within [Browserslist shareable configs](https://github.com/browserslist/browserslist#shareable-configs) option.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
.SH "NAME"
\fBBrowserslist\fR
.P
npm \fIhttps://img\.shields\.io/npm/v/@theholocron/browserslist\-average\-usage?color=red\fR \fIhttps://www\.npmjs\.com/package/@theholocron/browserslist\-average\-usage\fR Build Status \fIhttps://github\.com/the\-holocron/browserslist\-average\-usage/workflows/CI/badge\.svg\fR \fIhttps://github\.com/the\-holocron/browserslist\-average\-usage/actions?workflow=CI\fR semantic\-release \fIhttps://img\.shields\.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80\-semantic\-\-release\-e10079\.svg\fR \fIhttps://github\.com/semantic\-release/semantic\-release\fR Dependabot Status \fIhttps://api\.dependabot\.com/badges/status?host=github&repo=the\-holocron/browserslist\-average\-usage\fR \fIhttps://dependabot\.com\fR
npm \fIhttps://img\.shields\.io/npm/v/@theholocron/browserslist\-median\-usage?color=red\fR \fIhttps://www\.npmjs\.com/package/@theholocron/browserslist\-median\-usage\fR Build Status \fIhttps://github\.com/the\-holocron/browserslist\-median\-usage/workflows/CI/badge\.svg\fR \fIhttps://github\.com/the\-holocron/browserslist\-median\-usage/actions?workflow=CI\fR semantic\-release \fIhttps://img\.shields\.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80\-semantic\-\-release\-e10079\.svg\fR \fIhttps://github\.com/semantic\-release/semantic\-release\fR Dependabot Status \fIhttps://api\.dependabot\.com/badges/status?host=github&repo=the\-holocron/browserslist\-median\-usage\fR \fIhttps://dependabot\.com\fR
.P
A command\-line client that calculates the median level of browser usage based on custom stats in order to take advantage of Browserslist custom usage \fIhttps://github\.com/browserslist/browserslist#custom\-usage\-data\fR feature\.
.P
Expand All @@ -11,7 +11,7 @@ When building out custom usage data, often times the statistics you'll receive f
.P
.RS 2
.nf
npm install \-\-save @theholocron/browserslist\-average\-usage
npm install \-\-save @theholocron/browserslist\-median\-usage
.fi
.RE
.SH Table of Contents
Expand All @@ -38,23 +38,22 @@ Run the \fB\-\-help\fP or \fB\-h\fP command to find out how to use the command\.
.P
.RS 2
.nf
$ browserslist\-average\-usage \-\-help
Usage: browserslist\-average\-usage [options]
$ browserslist\-median\-usage \-\-help
Usage: browserslist\-median\-usage [options]

Options:
\-w, \-\-write Write to a browserslistrc\.json file [boolean]
\-\-verbose Turn on the logging [boolean]
\-h, \-\-help Show help [boolean]
\-v, \-\-version Show version number [boolean]

Commands:
browserslist\-average\-usage Calculates the median level of browser usage based on custom [aliases: get get\-average] [default]
browserslist\-median\-usage Calculates the median level of browser usage based on custom [aliases: get get\-median] [default]
stats in order to take advantage of Browserslist custom usage
browserslist\-average\-usage write [source] Writes to a source of ones choosing of where to store the [aliases: write\-file]
average usage statistics
browserslist\-median\-usage write [source] Writes to a source of ones choosing of where to store the [aliases: write\-file]
median usage statistics

Examples:
browserslist\-average\-usage
browserslist\-median\-usage

© 2020 The Holocron\. All rights reserved\.
.fi
Expand All @@ -64,14 +63,14 @@ Examples:
At this time, the client does not accept any input\.
.SS Return
.P
If the command succeeds, it will exit with a 0 code and the average percentage of browsers (e\.g\. \fB0\.03030739465585173\fP)\. Otherwise, it will exit with 1 code and an error message\.
If the command succeeds, it will exit with a 0 code and the median percentage of browsers (e\.g\. \fB0\.03030739465585173\fP)\. Otherwise, it will exit with 1 code and an error message\.
.SS Commands
.SS \fBget\fP
.P
This is the default command and doesn't require that you add \fBget\fP, as its only an alias\. Looks for a \fBbrowserlist\-stats\.json\fP file at the root of the library or code and calculates the average, then outputs to \fBstdout\fP\|\.
This is the default command and doesn't require that you add \fBget\fP, as its only an alias\. Looks for a \fBbrowserlist\-stats\.json\fP file at the root of the library or code and calculates the median, then outputs to \fBstdout\fP\|\.
.SS \fBwrite [source]\fP
.P
Grabs the average and writes the statistics to a source using the string \fB<percentage> in my stats\fP\|\. If the stats exist in the source, then it will update the value with the new statistics\.
Grabs the median and writes the statistics to a source using the string \fB<percentage> in my stats\fP\|\. If the stats exist in the source, then it will update the value with the new statistics\.
.P
The source can be one of two types: \fBpackage\fP or \fBconfig\fP\|\. For the package option, it will create or update the \fBbrowserslist\fP key within the \fBpackage\.json\fP\|\. For the config option, it will create or update a \fBbrowserslistrc\.json\fP file for use within Browserslist shareable configs \fIhttps://github\.com/browserslist/browserslist#shareable\-configs\fR option\.
.SH How We Track Changes Keep a Changelog \fIhttps://img\.shields\.io/badge/Keep%20a%20Changelog\-1\.0\.0\-orange\fR \fIhttps://keepachangelog\.com/en/1\.0\.0/\fR
Expand Down
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit fefba03

Please sign in to comment.