Skip to content

Commit 1878c03

Browse files
committed
chore: enforce conventional commits
1 parent 49e4c96 commit 1878c03

File tree

2 files changed

+29
-0
lines changed

2 files changed

+29
-0
lines changed

.github/workflows/commits.yml

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
on:
2+
pull_request:
3+
types: [opened, reopened, ready_for_review] # Currently, this action only support these events
4+
5+
jobs:
6+
hqprs:
7+
runs-on: ubuntu-latest
8+
steps:
9+
- name: Conventional PRs
10+
uses: Namchee/[email protected]
11+
with:
12+
access_token: ${{ secrets.GITHUB_TOKEN }}
13+
link_issue: false

CONTRIBUTING.md

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Contributing to Ferry
2+
3+
## Create a new issue
4+
5+
The easiest way to get involved is to create a [new issue](https://github.com/gql-dart/ferry/issues/new) when you spot a bug, if the documentation is incomplete or out of date, or if you identify an implementation problem.
6+
7+
## General coding guidlines
8+
9+
If you'd like to add a feature or fix a bug, we're more than happy to accept pull requests! We only ask a few things:
10+
11+
- Use [conventional commits](https://www.conventionalcommits.org/). This allows us to automatically build changelogs and publish `alpha` releases.
12+
- Ensure your code contains no analyzer errors.
13+
- Format your code with `dartfmt`.
14+
- Write tests for all new code paths, consider using the [Stream Matchers](https://pub.dartlang.org/packages/test#stream-matchers) available from the test package.
15+
- Write helpful documentation
16+
- If you would like to make a bigger / fundamental change to the codebase, please file a lightweight example PR / issue first.

0 commit comments

Comments
 (0)