You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This issue form is for requesting features only! For example, requesting a new component, behavior ... etc
15
-
If you want to report a bug, please use the [bug report form](https://github.com/nextui-org/nextui/issues/new?assignees=&labels=&template=bug_report.yml).
15
+
If you want to report a bug, please use the [bug report form](https://github.com/frontio-ai/heroui/issues/new?assignees=&labels=&template=bug_report.yml).
Copy file name to clipboardexpand all lines: CONTRIBUTING.md
+12-12
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,8 @@
1
-
# Next UI Contributing Guide
1
+
# HeroUI Contributing Guide
2
2
3
-
Hello!, I am very excited that you are interested in contributing with Next UI. However, before submitting your contribution, be sure to take a moment and read the following guidelines.
3
+
Hello!, I am very excited that you are interested in contributing with HeroUI. However, before submitting your contribution, be sure to take a moment and read the following guidelines.
4
4
5
-
-[Code of Conduct](https://github.com/jrgarciadev/nextui/blob/main/CODE_OF_CONDUCT.md)
5
+
-[Code of Conduct](https://github.com/frontio-ai/heroui/blob/canary/CODE_OF_CONDUCT.md)
As you canary, you can run `pnpm build --filter=<module>` and
84
84
`pnpm test packages/<module>/<pkg>` e.g. `pnpm build --filter=avatar & pnpm test packages/components/avatar` to make sure everything works as expected.
85
85
@@ -117,7 +117,7 @@ We use [Turbo Repo](https://turborepo.org/) for the project management.
117
117
2. If you will be working on the components source code, you can use the following command to start the webpack dev server:
118
118
119
119
```bash
120
-
## Start the dev babel server of NextUI core components
120
+
## Start the dev babel server of HeroUI core components
121
121
pnpm dev
122
122
123
123
## optional
@@ -128,10 +128,10 @@ pnpm dev:docs ## this will start the documentation next.js server and it will au
128
128
```
129
129
130
130
- If you will be working just on the documentation source code / mdx, you can use the following commands to build
131
-
NextUI components and then start the next.js dev server:
131
+
HeroUI components and then start the next.js dev server:
132
132
133
133
```bash
134
-
## Build NextUI source components
134
+
## Build HeroUI source components
135
135
pnpm build
136
136
137
137
## Start the next.js documentation dev server
@@ -210,21 +210,21 @@ When making a visual change, please provide screenshots
210
210
and/or screencasts of the proposed change. This will help us to understand the
211
211
desired change easier.
212
212
213
-
Until NextUI has a stable release new components will be created only for the core team.
213
+
Until HeroUI has a stable release new components will be created only for the core team.
214
214
215
215
## Documentation
216
216
217
217
Please update the docs with any API changes, the code and docs should always be in sync.
218
218
219
-
The main documentation lives in the `apps/docs/content` folder, the project uses MDX and all `NextUI` are already imported.
219
+
The main documentation lives in the `apps/docs/content` folder, the project uses MDX and all `HeroUI` are already imported.
220
220
221
221
## Breaking changes
222
222
223
223
Breaking changes should be accompanied with deprecations of removed functionality. The deprecated APIs themselves should not be removed until the minor release after that.
224
224
225
225
## Becoming a maintainer
226
226
227
-
If you are interested in becoming a NextUI maintainer, start by
227
+
If you are interested in becoming a HeroUI maintainer, start by
228
228
reviewing issues and pull requests. Answer questions for those in need of
0 commit comments