Skip to content

Latest commit

 

History

History
36 lines (21 loc) · 1.45 KB

CONTRIBUTING.md

File metadata and controls

36 lines (21 loc) · 1.45 KB

How to contribute

Thanks for considering contributing to Feed for Deno!

Getting Started

If you're new to contributing to open-source projects, you can start by checking out the GitHub documentation on how to contribute to a project.

Installation

The project uses Deno as the runtime environment. You can install Deno by following the instructions on the official website.

Commit Messages and Pull Requests

Please follow the conventional commit guidelines when writing commit messages. This will help us to generate the changelog automatically.

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.

Running Tests

You can run the tests using the following command:

deno test

If you want to run the tests on just a specific generator (e.g., RSS), you can use the following command:

deno test --filter "RSS"

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.

Note

Sometimes, the CI fails due to formatting issues. You can fix the formatting by running deno fmt and pushing the changes.