Skip to content

Commit 71cb86a

Browse files
committed
feat: add Contributing page
Signed-off-by: Gabriel Cozma <[email protected]>
1 parent e3815b2 commit 71cb86a

File tree

2 files changed

+37
-1
lines changed

2 files changed

+37
-1
lines changed

CONTRIBUTING.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# How to contribute
2+
3+
Thanks for considering contributing to Feed for Deno!
4+
5+
## Getting Started
6+
7+
If you're new to contributing to open-source projects, you can start by checking out the [GitHub documentation](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests) on how to contribute to a project.
8+
9+
### Installation
10+
11+
The project uses [Deno](https://deno.land/) as the runtime environment. You can install Deno by following the instructions on the [official website](https://deno.com/).
12+
13+
### Commit Messages and Pull Requests
14+
15+
Please follow the [conventional commit guidelines](https://www.conventionalcommits.org/en/v1.0.0/) when writing commit messages. This will help us to generate the changelog automatically.
16+
17+
When creating a pull request, please make sure to include a detailed description of the changes you made. This will help us to understand the changes and review the pull request faster.
18+
19+
## Running Tests
20+
21+
You can run the tests using the following command:
22+
23+
```bash
24+
deno test
25+
```
26+
27+
If you want to run the tests on just a specific generator (e.g., `RSS`), you can use the following command:
28+
29+
```bash
30+
deno test --filter "RSS"
31+
```
32+
33+
Every new pull request and commit will trigger the tests to run automatically using GitHub Actions. If the tests fail, the pull request will require a change to pass the tests.
34+
35+
> [!NOTE]
36+
> Sometimes, the CI fails due to formatting issues. You can fix the formatting by running `deno fmt` and pushing the changes.

deno.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,5 @@
22
"name": "@feed/feed",
33
"version": "1.0.1",
44
"exports": "./mod.ts",
5-
"exclude": [".github"]
5+
"exclude": [".github", "CONTRIBUTING.md"]
66
}

0 commit comments

Comments
 (0)