Skip to content

Commit 4d5f748

Browse files
committed
docs: fix contribution
1 parent 9253a84 commit 4d5f748

7 files changed

Lines changed: 37 additions & 68 deletions

File tree

.github/CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,4 @@ To get ready to work on the codebase, please do the following:
1010
2. Run `pnpm install --frozen-lockfile` ([install](https://pnpm.io/installation))
1111
3. Make your changes
1212
4. Run `pnpm format && pnpm build && pnpm test:unit` to run ESLint/Prettier, build and tests
13-
5. [Submit a pull request](https://github.com/NanoForge-dev/schematics/compare) (Make sure you follow the [conventional commit format](https://github.com/NanoForge-dev/CLI/blob/main/.github/COMMIT_CONVENTION.md))
13+
5. [Submit a pull request](https://github.com/NanoForge-dev/schematics/compare) (Make sure you follow the [conventional commit format](https://github.com/NanoForge-dev/schematics/blob/main/.github/COMMIT_CONVENTION.md))

.github/ISSUE_TEMPLATE/01-command_bug_report.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ body:
1717
- configuration
1818
- part-base
1919
- part-main
20+
- other
2021
validations:
2122
required: true
2223
- type: textarea

.github/ISSUE_TEMPLATE/02-feature_request.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,15 @@ body:
77
value: |
88
Thank you for submitting an idea !
99
- type: dropdown
10-
id: application_or_schematics
10+
id: schematics
1111
attributes:
1212
label: Which schematics is this feature request for?
1313
options:
1414
- application
1515
- configuration
1616
- part-base
1717
- part-main
18+
- other
1819
validations:
1920
required: true
2021
- type: textarea

.github/issue-labeler.yml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,3 +13,12 @@ schematics:part-base:
1313
schematics:part-main:
1414
- "### Which schematics is this (bug
1515
report|feature request) for\\?\\n\\npart-main\\n"
16+
17+
enhancement:
18+
- "### Which schematics is this feature request for\\?\\n"
19+
20+
bug:
21+
- "### Which schematics is this bug report for\\?\\n"
22+
23+
documentation:
24+
- "### What is the type of issue\\?\\n"

.github/labeler.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,3 +21,9 @@ schematics:part-main:
2121
- any-glob-to-any-file:
2222
- src/libs/part-main/*
2323
- src/libs/part-main/**/*
24+
25+
documentation:
26+
- changed-files:
27+
- any-glob-to-any-file:
28+
- docs/*
29+
- docs/**/*

README.md

Lines changed: 17 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,11 @@
55
</p>
66
<br />
77
<p>
8+
<a href="https://www.npmjs.com/package/@nanoforge-dev/schematics"><img src="https://img.shields.io/npm/v/@nanoforge-dev/schematics.svg?maxAge=3600" alt="npm version" /></a>
9+
<a href="https://www.npmjs.com/package/@nanoforge-dev/schematics"><img src="https://img.shields.io/npm/dt/@nanoforge-dev/schematics.svg?maxAge=3600" alt="npm downloads" /></a>
810
<a href="https://github.com/NanoForge-dev/schematics/actions"><img src="https://github.com/NanoForge-dev/schematics/actions/workflows/tests.yml/badge.svg" alt="Tests status" /></a>
9-
<a href="https://github.com/NanoForge-dev/schematics/commits/main"><img src="https://img.shields.io/github/last-commit/NanoForge-dev/schematics.svg?logo=github&logoColor=ffffff" alt="Last commit." /></a>
10-
<a href="https://github.com/NanoForge-dev/schematics/graphs/contributors"><img src="https://img.shields.io/github/contributors/NanoForge-dev/Schematics.svg?maxAge=3600&logo=github&logoColor=fff&color=00c7be" alt="contributors" /></a>
11+
<a href="https://github.com/NanoForge-dev/schematics/commits/main"><img src="https://img.shields.io/github/last-commit/NanoForge-dev/schematics.svg?logo=github&logoColor=ffffff" alt="Last commit" /></a>
12+
<a href="https://github.com/NanoForge-dev/schematics/graphs/contributors"><img src="https://img.shields.io/github/contributors/NanoForge-dev/schematics.svg?maxAge=3600&logo=github&logoColor=fff&color=00c7be" alt="Contributors" /></a>
1113
</p>
1214
</div>
1315

@@ -17,9 +19,9 @@ This repository contains the Schematics of NanoForge. Check [releases][github-re
1719

1820
## Usage
1921

20-
To use Nanoforge Schematics, please refer to the [Schematics documentation][cli-source] !
22+
To use Nanoforge Schematics, please refer to the [CLI documentation][cli-source] !
2123

22-
First, install the Schematics :
24+
First, install the CLI :
2325

2426
```bash
2527
npm install -g @nanoforge-dev/cli
@@ -31,63 +33,14 @@ And then create a new project :
3133
nf new
3234
```
3335

34-
## Commands
36+
## Schematics
3537

36-
The nanoforge client interface has multiple commands usable :
38+
This repository provide multiples schematics, usable with Angular Devkit schematics.
3739

38-
```sh
39-
nf [command] [options]
40-
```
41-
42-
### `build`
43-
44-
Used to build your nanoforge project.
45-
46-
`-d, --directory [directory]` specify the directory of the nanoforge project to build.
47-
`-c, --config [config]` path to the config file.
48-
`--client-outDir [clientDirectory]` specifies the client directory.
49-
`--server-outDir [serverDirectory]` specifies the server directory.
50-
51-
### `generate`
52-
53-
Used to generate nanoforge project files from config
54-
55-
`-d, --directory [directory]` specify the directory of the nanoforge project to build.
56-
`-c, --config [config]` path to the config file.
57-
58-
### `install` or `add`
59-
60-
Used to add a nanoforge library to your project
61-
62-
`-d, --directory [directory]` specify the directory of the nanoforge project to build.
63-
64-
### `new`
65-
66-
Used to create a new nanoforge project
67-
68-
`-d, --directory [directory]` specify the directory of your project
69-
`--name [name]` specify the name of your project
70-
`--path [path]` specify the path of your project
71-
`--package-manager [packageManager]` specify the package manager of your project
72-
`--language [language]` specify the language of your project
73-
`--strict` use strict mode
74-
`--no-strict` do not use strict mode
75-
`--server` create a server
76-
`--no-server` do not create a server
77-
`--init-functions` initialize functions
78-
`--no-init-functions` do not initialize functions
79-
`--skip-install` skip installing dependencies
80-
`--no-skip-install` do not skip installing dependencies
81-
82-
### `start`
83-
84-
Used to start your nanoforge project
85-
86-
`-d, --directory [directory]` specify the directory of your project
87-
`-c, --config [config]` path to the config file (default: "nanoforge.config.json")
88-
`-p, --client-port [clientPort]` specify the port of the loader (the website to load the game)
89-
`--game-exposure-port [gameExposurePort]` specify the port of the game exposure
90-
`--server-port [serverPort]` specify the port of the server
40+
- `application` : Base of a Nanoforge app
41+
- `configuration` : Template of `nanoforge.config.json` with premade fields
42+
- `part-base` : Base of Nanoforge client or server
43+
- `part-main` : Client or server `main.ts` from a config
9144

9245
## Contributing
9346

@@ -97,8 +50,8 @@ Please read through our [contribution guidelines][contributing] before starting
9750

9851
If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle nudge in the right direction, please ask on [Discussions][discussions].
9952

100-
[contributing]: https://github.com/NanoForge-dev/Schematics/blob/main/.github/CONTRIBUTING.md
101-
[discussions]: https://github.com/NanoForge-dev/Schematics/discussions
102-
[cli-source]: https://github.com/NanoForge-dev/Schematics
103-
[github-releases]: https://github.com/NanoForge-dev/Schematics/releases
104-
[good-first-issue]: https://github.com/NanoForge-dev/Schematics/contribute
53+
[contributing]: https://github.com/NanoForge-dev/schematics/blob/main/.github/CONTRIBUTING.md
54+
[discussions]: https://github.com/NanoForge-dev/schematics/discussions
55+
[cli-source]: https://github.com/NanoForge-dev/CLI
56+
[github-releases]: https://github.com/NanoForge-dev/schematics/releases
57+
[good-first-issue]: https://github.com/NanoForge-dev/schematics/contribute

package.json

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@
4444
"type": "git",
4545
"url": "git+https://github.com/NanoForge-dev/schematics.git"
4646
},
47-
"funding": "",
47+
"funding": "https://github.com/NanoForge-dev/schematics?sponsor",
4848
"scripts": {
4949
"build": "tsc --noEmit && tsup",
5050
"postbuild": "pnpm run copy:collection && pnpm run copy:lib",
@@ -79,7 +79,6 @@
7979
"husky": "^9.1.7",
8080
"lint-staged": "^16.2.6",
8181
"prettier": "^3.6.2",
82-
"taze": "^19.9.0",
8382
"tsup": "^8.5.1",
8483
"typescript": "^5.9.3",
8584
"typescript-eslint": "^8.46.2"

0 commit comments

Comments
 (0)