Skip to content

Commit e031420

Browse files
committed
feat: add CI workflow, contributing guidelines, and license file
1 parent e942c41 commit e031420

5 files changed

Lines changed: 108 additions & 2 deletions

File tree

.github/workflows/ci.yml

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
name: CI
2+
3+
on:
4+
push:
5+
branches: [main]
6+
pull_request:
7+
branches: [main]
8+
9+
jobs:
10+
build-and-test:
11+
runs-on: ubuntu-latest
12+
13+
steps:
14+
- uses: actions/checkout@v4
15+
16+
- name: Install pnpm
17+
uses: pnpm/action-setup@v4
18+
with:
19+
version: 10
20+
21+
- name: Set up Node.js
22+
uses: actions/setup-node@v4
23+
with:
24+
node-version: 20
25+
cache: 'pnpm'
26+
27+
- name: Install dependencies
28+
run: pnpm install
29+
30+
- name: Lint
31+
run: pnpm lint
32+
33+
- name: Format Check
34+
run: pnpm format
35+
36+
- name: Build
37+
run: pnpm build
38+
39+
# - name: Test
40+
# run: pnpm test

CONTRIBUTING.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Contributing to CLI & TUI Monorepo
2+
3+
First off, thank you for considering contributing to this project!
4+
5+
## How to Contribute
6+
7+
### Reporting Bugs
8+
- Use the GitHub issue tracker to report bugs.
9+
- Provide a clear and descriptive title.
10+
- Include steps to reproduce the issue.
11+
12+
### Pull Requests
13+
- Fork the repository and create your branch from `main`.
14+
- If you've added code that should be tested, add tests.
15+
- Ensure the test suite passes.
16+
- Make sure your code lints.
17+
18+
## Development Setup
19+
20+
### Prerequisites
21+
- Node.js ≥ 18.18
22+
- pnpm ≥ 9
23+
24+
### Setup
25+
```bash
26+
pnpm install
27+
```
28+
29+
### Building
30+
```bash
31+
pnpm run build
32+
```
33+
34+
### Linting
35+
```bash
36+
pnpm run lint
37+
pnpm run format
38+
```
39+
40+
## Code of Conduct
41+
Please be respectful and professional when contributing to this project.

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2026 CLI & TUI Monorepo Contributors
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,3 +37,9 @@ pnpm run dev
3737
pnpm run lint
3838
pnpm run format
3939
```
40+
41+
## Contributing
42+
Please see [CONTRIBUTING.md](CONTRIBUTING.md) for details on how to contribute to this project.
43+
44+
## License
45+
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

package.json

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,6 @@
1111
"scripts": {
1212
"build": "turbo build",
1313
"dev": "turbo dev",
14-
"link": "pnpm -C packages/cli link --global",
15-
"unlink": "pnpm -C packages/cli unlink --global",
1614
"clean": "turbo clean",
1715
"lint": "turbo lint",
1816
"format": "turbo format",

0 commit comments

Comments
 (0)