Skip to content

Commit 11660b0

Browse files
authored
Merge pull request #14 from abichinger/docs/contributing
docs(README): add contributing section
2 parents c1d1793 + e19f8a1 commit 11660b0

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,27 @@ This monorepo includes the following packages:
2323
- quasar - Quasar component
2424
- docs - Vue.js Cron documentation powered by [VuePress](https://vuepress.vuejs.org/)
2525

26+
# Contributing
27+
28+
Contributions are always welcome.
29+
30+
Before you open a PR, please make sure your changes comply with the following rules:
31+
- commits messages follow the [AngularJS commit message format](https://github.com/angular/angular/blob/main/CONTRIBUTING.md#commit)
32+
- `yarn lint` completes without errors
33+
- `yarn build` completes without errors
34+
- `yarn test` completes without errors
35+
36+
## Contributing new localization strings
37+
38+
You can use the commit [feat: add portuguese translation](https://github.com/abichinger/vue-js-cron/commit/64fbe1e7b30bd07e4e61b11cf98292f1cc81bfd4) as a reference.
39+
40+
[Here](https://abichinger.github.io/vue-js-cron/api/core.html#types) you can find the structure of a localization object.
41+
42+
## Contributors
43+
<a href="https://github.com/abichinger/vue-js-cron/graphs/contributors">
44+
<img src="https://contrib.rocks/image?repo=abichinger/vue-js-cron" />
45+
</a>
46+
2647
# Development
2748

2849
## Install dependencies

0 commit comments

Comments
 (0)