Skip to content

Commit 61fefc5

Browse files
committed
remove build step add contribution steps to readme to concure with new publish workflow
1 parent 2827834 commit 61fefc5

File tree

2 files changed

+19
-4
lines changed

2 files changed

+19
-4
lines changed

.github/workflows/publish.yml

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,6 @@ jobs:
2121
- name: Install dependencies
2222
run: npm install
2323

24-
- name: Run build (if you have a build step)
25-
run: npm run build
26-
2724
- name: Publish to npm
2825
run: npm publish
2926
env:

README.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -220,7 +220,25 @@ npm start
220220
221221
## 🤝 Contributing
222222
223-
We’d love your help! Fork the repo, make some changes, and send over a pull request.
223+
We’d love your help! Fork the repo, checkout the `pre-release` branch, make some changes, and send over a pull request. If you want to use the code for your local usage instead of installing it globally, follow these steps:
224+
225+
1. **Clone your forked repo:**
226+
```sh
227+
git clone https://github.com/your-username/command-ai.git
228+
cd command-ai
229+
```
230+
2. **Checkout the `pre-release` branch:**
231+
```sh
232+
git checkout pre-release
233+
```
234+
This branch is where we merge all the new features and bug fixes before they are released.
235+
3. **Link the project locally:**
236+
```sh
237+
npm link
238+
```
239+
After these steps, you can use the commands (ai, aic, aiq, etc.) from your local development environment without installing the package globally.
240+
241+
224242
225243
## 📜 License
226244

0 commit comments

Comments
 (0)