Skip to content

Commit dd45377

Browse files
committed
chore: contributing notes
1 parent 6c5adbc commit dd45377

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

.github/CONTRIBUTING.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Contributions are welcome and will be fully credited!
44

5-
We accept contributions via Pull Requests on [Github](https://github.com/{{ githubAccount }}/{{ name }}).
5+
We accept contributions via Pull Requests on [Github](<https://github.com/>{{ githubAccount }}/{{ name }}).
66

77
## Setup
88

@@ -19,3 +19,17 @@ Here are some guidelines to make the process smoother:
1919
- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests.
2020
- **Send coherent history** - Make sure your commits message means something
2121
- **Consider our release cycle** - We try to follow [SemVer v2.0.0](http://semver.org/). Randomly breaking public APIs is not an option.
22+
23+
## Project structure
24+
25+
### Root
26+
27+
The root folder includes the VueFire library
28+
29+
### `packages/nuxt`
30+
31+
This folder includes the Nuxt module. To have proper TS support in your IDE, you might need to open this folder individually rather than opening the root folder of the VueFire project.
32+
33+
### `playground`
34+
35+
Includes a Vue 3 playground to test out with a real app.

0 commit comments

Comments
 (0)