You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+34-24Lines changed: 34 additions & 24 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,47 +1,45 @@
1
1
# Gitify Contributing Guide
2
2
3
-
Hi! We're really excited that you're interested in contributing to Gitify! Before submitting your contribution, please read through the following guide. We also suggest you read the [Project Philosophy](#project-philosophy) in our documentation.
3
+
Hi! We're really excited that you're interested in contributing to Gitify!
4
4
5
-
### Installation
5
+
Before submitting your contribution, please read through the following guide.
6
6
7
-
To get started, you'll need to clone the repository and install the dependencies.
8
-
9
-
```shell
10
-
pnpm install
11
-
```
12
-
13
-
### Development
7
+
We also suggest you read the [Project Philosophy](#project-philosophy) in our documentation.
14
8
9
+
### Getting Started
15
10
> [!TIP]
16
11
> _Optional: If you prefer to use your own OAuth credentials, you can do so by passing them as environment variables when bundling the app. This is optional as the app has some default "development" keys (use at your own discretion)._
17
12
> ```shell
18
13
> OAUTH_CLIENT_ID="123" pnpm build
19
14
>```
20
15
21
-
Copy the `.env.template` to `.env` and add update `GITHUB_TOKEN` with a GitHub Personal Access Token. This is used for fetching the latest GitHub GraphQL API schema for`graphql-codegen`.
22
-
```shell
23
-
GITHUB_TOKEN=<some personal access token>
24
-
```
16
+
To get started:
25
17
26
-
To watch for changes (`webpack`) in the `src` directory:
18
+
Clone the repository and install dependencies:
19
+
```shell
20
+
pnpm install
21
+
```
27
22
23
+
Copy the `.env.template` to `.env` and add update `GITHUB_TOKEN` with a GitHub Personal Access Token. This is used for fetching the latest GitHub GraphQL API schema for `graphql-codegen`.
28
24
```shell
29
-
pnpm watch
25
+
GITHUB_TOKEN=<some personal access token>
30
26
```
31
27
32
-
To run the **electron app**:
28
+
Build static resources (tray icons, twemojis, etc). You only need to rebuild if you change static assets:
29
+
```shell
30
+
pnpm build
31
+
```
33
32
34
-
```shell
35
-
pnpm start
36
-
```
37
-
38
-
To reload the app with the changes that `pnpm watch` has detected, you can use the `CmdOrCtrl+R` shortcut.
33
+
Start development mode (includes GraphQL codegen and hot module reload):
34
+
```shell
35
+
pnpm dev
36
+
```
39
37
40
38
### Tests
41
39
42
-
There are 2 checks:
43
-
1.linter & formatter with [biome][biome-website]
44
-
2.unit tests with [jvitestt][vitest-website]
40
+
There are two main checks:
41
+
1.Linter & formatter with [Biome][biome-website]
42
+
2.Unit tests with [Vitest][vitest-website]
45
43
46
44
```shell
47
45
# Run biome to check linting and formatting
@@ -54,6 +52,17 @@ pnpm test
54
52
pnpm test -u
55
53
```
56
54
55
+
### Code Style & Conventions
56
+
57
+
- We use [Biome][biome-website] for linting and formatting. Please run `pnpm lint:check` before submitting a PR.
58
+
- Follow existing file and folder naming conventions.
59
+
- Keep commit messages clear and descriptive.
60
+
61
+
### How to Report Bugs or Request Features
62
+
63
+
If you encounter a bug or have a feature request, please [open an issue][github-issues] with clear steps to reproduce or a detailed description of your idea. Check for existing issues before creating a new one.
64
+
65
+
57
66
### Releases
58
67
59
68
The release process is automated. Follow the steps below.
@@ -95,6 +104,7 @@ This project is a tool for monitoring new notifications from GitHub. It's not me
0 commit comments