teal.fm
Your music, beautifully tracked. All yours. (coming soon)
teal.fm
teal-fm
atproto
Add contributing doc!
init contributing doc
+53
CONTRIBUTING.md
+53
CONTRIBUTING.md
···
1
+
# Contributing
2
+
3
+
Hi, thanks for showing interest in our project, we appreciate you wanting to be
4
+
a part of it!
5
+
6
+
> ###### Do you accept external contributions?
7
+
> Yes, we welcome external contributions! The only request we have is that you
8
+
> check with us before working on a large feature, as we'd prefer to avoid duplicating effort.
9
+
>
10
+
> You can do this by either creating an issue that we can communicate through, or
11
+
> popping into the Discord channel and asking in the #development channel.
12
+
> Whatever works best for you!
13
+
>
14
+
> Other than that, feel free to contribute however you'd like!
15
+
16
+
Fork, then clone the repo:
17
+
18
+
git clone git@github.com:your-username/teal.git
19
+
20
+
Set up your machine:
21
+
22
+
```bash
23
+
pnpm install && pnpm install -g turbo && cp apps/aqua/.env.example apps/aqua/.env &&
24
+
pnpm run db:migrate
25
+
```
26
+
27
+
## Development
28
+
29
+
To start the monorepo run:
30
+
31
+
```bash
32
+
turbo dev
33
+
```
34
+
35
+
If you only want to start one service run:
36
+
37
+
```bash
38
+
turbo dev --filter=<service_path>
39
+
```
40
+
41
+
Open http://localhost:3000/ with your browser to see the home page. You will need
42
+
to login with Bluesky to test the posting functionality of the app. Note: if the
43
+
redirect back to the app after you login isn't working correctly, you may need to
44
+
replace the `127.0.0.1` with `localhost`.
45
+
46
+
Push to your fork and [submit a pull request][pr].
47
+
48
+
[pr]: https://github.com/teal-fm/teal/compare/
49
+
50
+
Now you're waiting on us! We'll try to comment on the pull request as soon as
51
+
we can!
52
+
53
+
Thanks again!