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
- Introduced a new `CONTRIBUTING.md` to guide contributors on setting up the development environment, running tests, and submitting pull requests.
- Included installation instructions for the Bun runtime on various operating systems.
- Aimed to enhance collaboration and streamline the contribution process for the project.
Thank you for considering contributing to `apr` 😀! We welcome contributions from everyone. By participating in this project, you agree to abide by our [Code of Conduct](CODE_OF_CONDUCT.md).
4
+
5
+
## Setting Up the Development Environment
6
+
7
+
1.[Fork the Project](https://github.com/cli-stuff/apr/fork)
8
+
2. Create a new branch for your changes:
9
+
10
+
```bash
11
+
git checkout -b my-feature-branch
12
+
```
13
+
14
+
3. Install the dependencies:
15
+
16
+
```bash
17
+
bun install
18
+
```
19
+
20
+
### Bun runtime
21
+
22
+
If you don't have [Bun](https://bun.sh/) installed, you can install it using this command:
23
+
24
+
#### Windows
25
+
26
+
```powershell
27
+
powershell -c "irm bun.sh/install.ps1 | iex"
28
+
```
29
+
30
+
#### Linux, macOS, Windows ([WSL](https://learn.microsoft.com/windows/wsl/install))
31
+
32
+
```bash
33
+
curl -fsSL bun.sh/install | bash
34
+
```
35
+
36
+
37
+
## Running Tests and Building the Project
38
+
39
+
To run the tests, use the following command:
40
+
41
+
```bash
42
+
bun run test
43
+
```
44
+
45
+
To build the project, use the following command:
46
+
47
+
```bash
48
+
bun run build
49
+
```
50
+
51
+
## Submitting Pull Requests
52
+
53
+
1. Commit your Changes (git commit -m 'Add some AmazingFeature')
54
+
2. Push your branch to your fork:
55
+
56
+
```bash
57
+
git push origin my-feature-branch
58
+
```
59
+
60
+
3.[Open a Pull Request on GitHub](https://github.com/cli-stuff/apr/pulls) and provide a description of your changes.
0 commit comments