Skip to content

Commit 37ed0d6

Browse files
authored
Create CONTRIBUTING.md
1 parent 5339f38 commit 37ed0d6

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

CONTRIBUTING.md

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Contributing
2+
3+
Contributions to Primo are very welcome. You can start by submitting a PR to address any of the [open issues](https://github.com/primocms/primo/issues), but for the sake of keeping the codebase simple and aligned towards the project's mission, we ask that you first start a discussion before attempting to contribute any new features. You can do this by starting a discussion in the [Forum](https://forum.primo.so), [Github Discussions](https://github.com/primocms/primo/discussions), or the [Discord](https://discord.gg/vzSFTS9). Or, if you'd like to contribute to the project but don't know where to start, feel free to fill out the [contributor form](https://primocms.org/contributions).
4+
5+
## Running locally
6+
7+
1. Clone the main Primo repo
8+
```
9+
git clone https://github.com/primocms/primo.git
10+
```
11+
2. Clone the builder repo
12+
```
13+
git clone https://github.com/primocms/builder
14+
```
15+
3. Link the builder to Primo
16+
```
17+
cd builder
18+
npm link
19+
npm install
20+
npm run package-watch
21+
```
22+
4. Run Primo
23+
```
24+
cd ../primo
25+
npm install
26+
npm link @primocms/builder
27+
npm run dev
28+
```
29+
5. Open your browser to http://localhost:5173
30+
31+
If you have any issues setting this up, it's probably *not* just you, so feel free to pop into any of the discussion spaces linked above for some help.

0 commit comments

Comments
 (0)