Skip to content
This repository has been archived by the owner on May 25, 2024. It is now read-only.

Commit

Permalink
Kaustav | #43 | Renamed package name rg-cli to regauge. | TG-43
Browse files Browse the repository at this point in the history
  • Loading branch information
phoenixTW committed Aug 5, 2019
1 parent bddad23 commit 80e8b80
Show file tree
Hide file tree
Showing 18 changed files with 95 additions and 87 deletions.
2 changes: 1 addition & 1 deletion .circleci/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ jobs:

workflows:
version: 2
"@itchef/rg-cli":
"regauge":
jobs:
- node-latest
- node-10
Expand Down
8 changes: 4 additions & 4 deletions .github/ISSUE_TEMPLATE/1-bug-report.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
---
name: "🐞 Bug report"
about: Report a bug in @itchef/rg-cli
about: Report a bug in regauge
---

# 🐞 bug report

<!-- Before you reporting a bug, please take a look at our issue section to make sure there is no duplicate issue present. -->

### Affected Package
<!-- Could you please point out one or more rg-cli or @itchef/* packages as the source of the bug? -->
<!-- Could you please point out one or more regauge or @itchef/* packages as the source of the bug? -->
<!-- ✍️ edit: --> The issue is caused by package @itchef/....


Expand All @@ -19,7 +19,7 @@ Yes, the previous version in which this bug was not present was: ....

### Possible affected versions:

<!-- Please note the possible affected rg-cli versions. -->
<!-- Please note the possible affected regauge versions. -->
The affected versions are: ....

### Description
Expand All @@ -41,7 +41,7 @@ Please share the reproduction steps by which we can identify the issue. Adding a

## 🌏 Your Environment

**rg-cli Version:**
**regauge Version:**
<pre><code>
<!-- run `rg --version` and paste output below -->

Expand Down
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/2-feature-request.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: "✈️ Feature request"
about: Suggest a feature for @itchef/rg-cli
about: Suggest a feature for regauge

---
<!-- Hello! ☺️
Expand All @@ -11,7 +11,7 @@ To make this wonderful feature more relevant, please take a look at our open and
# 🚀 feature request

### Target packages
<!-- Could you please point out one or more @itchef/rg-cli packages the are relevant for this feature request? -->
<!-- Could you please point out one or more regauge packages the are relevant for this feature request? -->
This feature request is for ....

### Brief description about the feature
Expand Down
8 changes: 4 additions & 4 deletions .github/ISSUE_TEMPLATE/docs-bug.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
---
name: "📚 Docs or itchef.github.com/rg-cli issue report"
about: Report an issue in rg-cli's documentation or website.
name: "📚 Docs or itchef.github.com/regauge issue report"
about: Report an issue in regauge's documentation or website.

---
<!-- Hello! ☺️
To make this important issue more relevant, please take a look at our open and closed issues before submitting this one. Who knows you might find a mate who is also worried about the same bug. Also it might contain the information regarding workarounds, resolution, or progress updates.
-->

# 📚 Docs or itchef.github.com/rg-cli bug report
# 📚 Docs or itchef.github.com/regauge bug report

### Description

Expand All @@ -22,7 +22,7 @@ Please share the reproduction steps by which we can identify the issue. Adding a


### What's the affected URL?**
https://itchef.github.io/rg-cli/...
https://itchef.github.io/regauge/...

## 🚨 Error

Expand Down
2 changes: 2 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ 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.

Communication through any of Angular's channels (GitHub, Gitter, mailing lists etc.) must be constructive and never resort to personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.

## Our Standards

Examples of behavior that contributes to creating a positive environment
Expand Down
10 changes: 5 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,23 @@
# Contributing
The following is a set of guidelines for contributing to rg-cli. Please spend few minutes in reading these guidelines before you create an issue or pull request.
The following is a set of guidelines for contributing to regauge. Please spend few minutes in reading these guidelines before you create an issue or pull request.

## Code of Conduct

We have adopted a [Code of Conduct](./CODE_OF_CONDUCT.md) that we expect project participants to adhere to. Please read the full text so that you can understand what actions will and will not be tolerated.

## Open Development

All code level work for rg-cli happens on [Github](https://github.com/itchef/rg-cli). External contributors are welcome to send pull requests which will go through the review process by the core team.
All code level work for regauge happens on [Github](https://github.com/itchef/regauge). External contributors are welcome to send pull requests which will go through the review process by the core team.

## Branch Organization

We follow the trunk based development. Hence we maintain only single branch `master`. If you send a bugfix pull request, feature pull request, please do it against the `master` branch.

## Bugs & Features

We are using [GitHub Issues](https://github.com/itchef/rg-cli/issues) for bug and feature tracing. The best way to contribute with bug fixes is by creating a new bug using this [template](https://github.com/itchef/rg-cli/issues/new?template=1-bug-report.md).
We are using [GitHub Issues](https://github.com/itchef/regauge/issues) for bug and feature tracing. The best way to contribute with bug fixes is by creating a new bug using this [template](https://github.com/itchef/regauge/issues/new?template=1-bug-report.md).

If You want to propose a new feature, please use this [feature template](https://github.com/itchef/rg-cli/issues/new?template=2-feature-request.md) to create a new feature request.
If You want to propose a new feature, please use this [feature template](https://github.com/itchef/regauge/issues/new?template=2-feature-request.md) to create a new feature request.

## Your First Pull Request

Expand Down Expand Up @@ -47,6 +47,6 @@ The [core team](https://github.com/orgs/itchef/people) is monitoring for pull re

After cloning antd, run `npm install` to fetch its dependencies. Then, you can run several commands:

1. `./bin/run COMMAND`. Check all cli commands [here](https://itchef.github.io/rg-cli/docs/cli-command-new).
1. `./bin/run COMMAND`. Check all cli commands [here](https://itchef.github.io/regauge/docs/cli-command-new).
2. `npm test` runs the complete test suite.
3. `npm version` shows the latest released version of the application.
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

@itchef/rg-cli
regauge

Copyright (c) 2019, ITChef <https://github.com/itchef/>

Expand Down
29 changes: 15 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,17 @@
@itchef/rg-cli
regauge
==============

A CLI tool to create and manage initial react project bundled with webpack, prettier and many more.

[![npm](https://img.shields.io/npm/v/@itchef/rg-cli?style=for-the-badge&cacheSeconds=360)](https://npmjs.org/package/@itchef/rg-cli)
[![CircleCI](https://img.shields.io/circleci/build/github/itchef/rg-cli?style=for-the-badge&cacheSeconds=360&logo=CircleCi&circle-token=ae9a68f7db509eb9281e2890eac3f50af93dabd9)](https://circleci.com/gh/itchef/rg-cli)
[![DOWNLOADS](https://img.shields.io/npm/dm/@itchef/rg-cli?style=for-the-badge&cacheSeconds=360)](https://npmjs.org/package/@itchef/rg-cli)
[![npm bundle size](https://img.shields.io/bundlephobia/min/@itchef/rg-cli?style=for-the-badge&cacheSeconds=360)](https://bundlephobia.com/result?p=@itchef/rg-cli)
[![LICENSE](https://img.shields.io/npm/l/@itchef/rg-cli?style=for-the-badge&cacheSeconds=360)
[![npm](https://img.shields.io/npm/v/regauge?style=for-the-badge&cacheSeconds=360)](https://npmjs.org/package/regauge)
[![CircleCI](https://img.shields.io/circleci/build/github/itchef/regauge?style=for-the-badge&cacheSeconds=360&logo=CircleCi&circle-token=ae9a68f7db509eb9281e2890eac3f50af93dabd9)](https://circleci.com/gh/itchef/regauge)
[![DOWNLOADS](https://img.shields.io/npm/dm/regauge?style=for-the-badge&cacheSeconds=360)](https://npmjs.org/package/regauge)
[![npm bundle size](https://img.shields.io/bundlephobia/min/regauge?style=for-the-badge&cacheSeconds=360)](https://bundlephobia.com/result?p=regauge)
[![LICENSE](https://img.shields.io/npm/l/regauge?style=for-the-badge&cacheSeconds=360)
](./LICENSE)
[![WEBSITE](https://img.shields.io/badge/Official-Website-blue?style=for-the-badge&cacheSeconds=360)
](https://itchef.github.io/rg-cli)
](https://itchef.github.io/regauge)
[![CHAT](https://img.shields.io/gitter/room/itchef/regauge?style=for-the-badge)](https://gitter.im/Itcheforg/regauge)

* [Usage](#usage)
* [Commands](#commands)
Expand All @@ -20,11 +21,11 @@ A CLI tool to create and manage initial react project bundled with webpack, pret
# Usage

```sh-session
$ npm install -g @itchef/rg-cli
$ npm install -g regauge
$ rg COMMAND
running command...
$ rg (-v|--version|version)
@itchef/rg-cli/0.2.0 darwin-x64 node-v11.5.0
regauge/0.2.0 darwin-x64 node-v11.5.0
$ rg --help [COMMAND]
USAGE
$ rg COMMAND
Expand Down Expand Up @@ -55,7 +56,7 @@ EXAMPLES
$ rg g c COMPONENT
```

_See code: [src/commands/generate.js](https://github.com/ITChef/rg-cli/blob/v0.2.0/src/commands/generate.js)_
_See code: [src/commands/generate.js](https://github.com/ITChef/regauge/blob/v0.2.0/src/commands/generate.js)_

## `rg help [COMMAND]`

Expand All @@ -76,7 +77,7 @@ _See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v2.1.6

## `rg new APPNAME`

To generate a new rg-cli project.
To generate a new regauge project.

```
USAGE
Expand All @@ -89,14 +90,14 @@ OPTIONS
-h, --help show CLI help
```

_See code: [src/commands/new.js](https://github.com/ITChef/rg-cli/blob/v0.2.0/src/commands/new.js)_
_See code: [src/commands/new.js](https://github.com/ITChef/regauge/blob/v0.2.0/src/commands/new.js)_
<!-- commandsstop -->

# Contributing

Read our [contributing guide](./CONTRIBUTING.md) and let's build a better rg-cli together.
Read our [contributing guide](./CONTRIBUTING.md) and let's build a better regauge together.

We welcome all contributions. You can submit any ideas as [pull requests](https://github.com/itchef/rg-cli/pulls) or as [GitHub issues](https://github.com/itchef/rg-cli/issues).
We welcome all contributions. You can submit any ideas as [pull requests](https://github.com/itchef/regauge/pulls) or as [GitHub issues](https://github.com/itchef/regauge/issues).

# License

Expand Down
6 changes: 3 additions & 3 deletions docusaurus/docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,19 +8,19 @@ React Generator CLI is a CLI tool to generate your working React application wit
## Quick Start

```sh
npx @itchef/rg-cli new my-app
npx regauge new my-app
cd my-app
npm start
```

> If you've previously installed `rg-cli` globally via `npm install -g rg-cli`, the you can run the following,
> If you've previously installed `regauge` globally via `npm install -g regauge`, the you can run the following,
```sh
rg new my-app
cd my-app
npm start
```

> It is always recommended to use the latest version of rg-cli. Using `npx` it is the best way to generate a new react application, as it always uses the `latest` version.
> It is always recommended to use the latest version of regauge. Using `npx` it is the best way to generate a new react application, as it always uses the `latest` version.
_([npx](https://medium.com/@maybekatz/introducing-npx-an-npm-package-runner-55f7d4bd282b) comes with npm 5.2+ and higher, see [instructions for older npm versions](https://gist.github.com/gaearon/4064d3c23a77c74a3614c498a8bb1c5f))_

Expand Down
4 changes: 2 additions & 2 deletions docusaurus/docs/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ This docs assume that you are already familiar with HTML, CSS, JavaScript and so

#### We are loved to hear from you.

We want to hear active feedback from you. [Report problems or provide us some suggestion](https://github.com/itchef/rg-cli/issues) to make this docs more reader friendly.
We want to hear active feedback from you. [Report problems or provide us some suggestion](https://github.com/itchef/regauge/issues) to make this docs more reader friendly.

Contribute to React Generator CLI docs by creating [pull requests](https://github.com/itchef/rg-cli/pulls) on the React Generator CLI Github repository.
Contribute to React Generator CLI docs by creating [pull requests](https://github.com/itchef/regauge/pulls) on the React Generator CLI Github repository.


Loading

0 comments on commit 80e8b80

Please sign in to comment.