Skip to content

Commit 4fd26d4

Browse files
committed
chore: first init
1 parent cda2c20 commit 4fd26d4

34 files changed

+5614
-198
lines changed

.github/CONTRIBUTING.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Contributing
2+
3+
Contributions are welcome and will be fully credited!
4+
5+
We accept contributions via Pull Requests on [Github](https://github.com/{{ githubAccount }}/{{ name }}).
6+
7+
## Pull Requests
8+
9+
Here are some guidelines to make the process smoother:
10+
11+
- **Add a test** - New features and bugfixes need tests. If you find it difficult to test, please tell us in the pull request and we will try to help you!
12+
- **Document any change in behaviour** - Make sure the `README.md` and any other relevant documentation are kept up-to-date.
13+
- **Run `npm test` locally** - This will allow you to go faster
14+
- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests.
15+
- **Send coherent history** - Make sure your commits message means something
16+
- **Consider our release cycle** - We try to follow [SemVer v2.0.0](http://semver.org/). Randomly breaking public APIs is not an option.
17+
18+
## Creating issues
19+
20+
### Bug reports
21+
22+
Always try to provide as much information as possible. If you are reporting a bug, try to provide a repro on jsfiddle.net (or anything else) or a stacktrace at the very least. This will help us check the problem quicker.
23+
24+
### Feature requests
25+
26+
Lay out the reasoning behind it and propose an API for it. Ideally, you should have a practical example to prove the utility of the feature you're requesting.

.github/FUNDING.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
github: [antfu]
1+
github: [CodeDredd]

.github/ISSUE_TEMPLATE.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
<!--
2+
IMPORTANT: Please provide as much information as possible:
3+
4+
- Reporting a bug: Provide a reproduction using this template: https://github.com/piniajs/bug-report
5+
If no reproduction is provided, your issue will be closed or moved to a discussion.
6+
7+
- Feature request: lay out the reasoning behind it and propose an API for it
8+
9+
-->
Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
name: 🐞 Bug report
2+
description: Create a report to help us improve Pinia ORM
3+
labels: [pending triage]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Please use a template below to create a minimal reproduction
9+
👉 https://stackblitz.com/github/nuxt/starter/tree/v3-stackblitz
10+
👉 https://codesandbox.io/s/github/nuxt/starter/tree/v3-codesandbox
11+
- type: textarea
12+
id: bug-env
13+
attributes:
14+
label: Environment
15+
description: You can use e.g. `npx nuxi info` for nuxt to fill this section
16+
placeholder: Environment
17+
validations:
18+
required: true
19+
- type: textarea
20+
id: reproduction
21+
attributes:
22+
label: Reproduction
23+
description: Please provide a link to a repo that can reproduce the problem you ran into. A [**minimal reproduction**](https://v3.nuxtjs.org/community/reporting-bugs#create-a-minimal-reproduction) is required unless you are absolutely sure that the issue is obvious and the provided information is enough to understand the problem. If a report is vague (e.g. just a generic error message) and has no reproduction, it will receive a "need reproduction" label. If no reproduction is provided we might close it.
24+
placeholder: Reproduction
25+
validations:
26+
required: true
27+
- type: textarea
28+
id: bug-description
29+
attributes:
30+
label: Describe the bug
31+
description: A clear and concise description of what the bug is. If you intend to submit a PR for this issue, tell us in the description. Thanks!
32+
placeholder: Bug description
33+
validations:
34+
required: true
35+
- type: textarea
36+
id: additonal
37+
attributes:
38+
label: Additional context
39+
description: If applicable, add any other context about the problem here`
40+
- type: textarea
41+
id: logs
42+
attributes:
43+
label: Logs
44+
description: |
45+
Optional if provided reproduction. Please try not to insert an image but copy paste the log text.
46+
render: shell

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
contact_links:
2+
- name: 💬 Discussions
3+
url: https://github.com/CodeDredd/pinia-orm/discussions
4+
about: Ask a question or discuss about Pinia ORM
5+
- name: ☝ Ideas
6+
url: https://github.com/CodeDredd/pinia-orm/discussions/new?category=Ideas
7+
about: Start a discussion to improve Pinia
8+
- name: ❤ GitHub Sponsors
9+
url: https://github.com/sponsors/codedredd
10+
about: Like this project? Please consider supporting the author.
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
name: 🚀 Feature request
2+
description: Suggest a feature that will improve Pinia ORM
3+
labels: [pending triage]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thank you for taking the time to fill out this feature request!
9+
- type: textarea
10+
id: feature-description
11+
attributes:
12+
label: Describe the feature
13+
description: A clear and concise description of what you think would be a helpful addition to Nuxt, including the possible use cases and alternatives you have considered. If you have a working prototype or module that implements it, please include a link.
14+
placeholder: Feature description
15+
validations:
16+
required: true
17+
- type: checkboxes
18+
id: additional-info
19+
attributes:
20+
label: Additional information
21+
description: Additional information that helps us decide how to proceed.
22+
options:
23+
- label: Would you be willing to help implement this feature?
24+
- label: Could this feature be implemented as a module?
25+
- type: checkboxes
26+
id: required-info
27+
attributes:
28+
label: Final checks
29+
description: Before submitting, please make sure you do the following
30+
options:
31+
- label: Check existing [discussions](https://github.com/CodeDredd/pinia-orm/discussions) and [issues](https://github.com/CodeDredd/pinia-orm/issues).
32+
required: true

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
<!---
2+
☝️ PR title should follow conventional commits (https://conventionalcommits.org)
3+
-->
4+
5+
### 🔗 Linked issue
6+
7+
<!-- Please ensure there is an open issue and mention its number as #123 -->
8+
9+
### ❓ Type of change
10+
11+
<!-- What types of changes does your code introduce? Put an `x` in all the boxes that apply. -->
12+
13+
- [ ] 📖 Documentation (updates to the documentation or readme)
14+
- [ ] 🐞 Bug fix (a non-breaking change that fixes an issue)
15+
- [ ] 👌 Enhancement (improving an existing functionality like performance)
16+
- [ ] ✨ New feature (a non-breaking change that adds functionality)
17+
- [ ] ⚠️ Breaking change (fix or feature that would cause existing functionality to change)
18+
19+
### 📚 Description
20+
21+
<!-- Describe your changes in detail -->
22+
<!-- Why is this change required? What problem does it solve? -->
23+
<!-- If it resolves an open issue, please link to the issue here. For example "Resolves #1337" -->
24+
25+
### 📝 Checklist
26+
27+
<!-- Put an `x` in all the boxes that apply. -->
28+
<!-- If your change requires a documentation PR, please link it appropriately -->
29+
<!-- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
30+
31+
- [ ] I have linked an issue or discussion.
32+
- [ ] I have updated the documentation accordingly.

.github/workflows/ci.yml

Lines changed: 12 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -59,29 +59,22 @@ jobs:
5959

6060
strategy:
6161
matrix:
62-
node: [16.x, 18.x]
62+
node: [16, 18, 20]
6363
os: [ubuntu-latest, windows-latest, macos-latest]
6464
fail-fast: false
6565

6666
steps:
6767
- uses: actions/checkout@v3
68-
69-
- name: Install pnpm
70-
uses: pnpm/action-setup@v2
71-
72-
- name: Set node ${{ matrix.node }}
73-
uses: actions/setup-node@v3
68+
with:
69+
fetch-depth: 0
70+
- run: corepack enable
71+
- uses: actions/setup-node@v3
7472
with:
7573
node-version: ${{ matrix.node }}
76-
77-
- name: Setup
78-
run: npm i -g @antfu/ni
79-
80-
- name: Install
81-
run: nci
82-
83-
- name: Build
84-
run: nr build
85-
86-
- name: Test
87-
run: nr test
74+
cache: pnpm
75+
- run: pnpm install
76+
- run: pnpm lint
77+
- run: pnpm build
78+
- run: pnpm test:types
79+
- run: pnpm vitest --coverage && rm -rf coverage/tmp
80+
- uses: codecov/codecov-action@v3

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,4 @@ lib-cov
99
logs
1010
node_modules
1111
temp
12+
.idea

CONTRIBUTING.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

0 commit comments

Comments
 (0)