mirror of
https://github.com/hernikplays/freelo-action.git
synced 2024-09-19 21:23:19 +02:00
69 lines
2.8 KiB
Markdown
69 lines
2.8 KiB
Markdown
# Contributing
|
|
Thanks for your interest in this project. Below are ways on how to contribute.
|
|
|
|
## Code
|
|
Want to see something implemented? Why not do it yourself! (Will be very much appreciated, as I am a busy man)
|
|
### Style
|
|
- Commits follow the [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) style
|
|
- Linting and formatting is done through [Biome](https://biomejs.dev/)
|
|
### Set up
|
|
0. Install [bun](https://bun.sh)
|
|
1. Fork and clone the repo: `git clone https://github.com/YourUsername/freelo-action && cd freelo-action`
|
|
2. Install dependencies: `bun install`
|
|
4. Create a new feature branch: `git checkout -b feat-myawesomefeature`
|
|
5. Add your code
|
|
6. Build a JS version to be used inside the action: `bun run build`
|
|
7. Run lints: `bunx biome check` (use `--write` option to automatically apply fixes)
|
|
8. Commit your code: `git add . && git commit -m "feat: new feature" && git push`
|
|
9. Create a pull request through GitHub
|
|
|
|
Wow! Who's awesome? You're awesome! I'll try my best to check your PR ASAP, but no promises there.
|
|
Please note that **contributing to this project means agreeing to the Developer Certificate of Origin**, as written below.
|
|
|
|
<details>
|
|
|
|
<summary>Developer Certificate of Origin text</summary>
|
|
|
|
```
|
|
Developer Certificate of Origin
|
|
Version 1.1
|
|
|
|
Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
|
|
|
|
Everyone is permitted to copy and distribute verbatim copies of this
|
|
license document, but changing it is not allowed.
|
|
|
|
|
|
Developer's Certificate of Origin 1.1
|
|
|
|
By making a contribution to this project, I certify that:
|
|
|
|
(a) The contribution was created in whole or in part by me and I
|
|
have the right to submit it under the open source license
|
|
indicated in the file; or
|
|
|
|
(b) The contribution is based upon previous work that, to the best
|
|
of my knowledge, is covered under an appropriate open source
|
|
license and I have the right under that license to submit that
|
|
work with modifications, whether created in whole or in part
|
|
by me, under the same open source license (unless I am
|
|
permitted to submit under a different license), as indicated
|
|
in the file; or
|
|
|
|
(c) The contribution was provided directly to me by some other
|
|
person who certified (a), (b) or (c) and I have not modified
|
|
it.
|
|
|
|
(d) I understand and agree that this project and the contribution
|
|
are public and that a record of the contribution (including all
|
|
personal information I submit with it, including my sign-off) is
|
|
maintained indefinitely and may be redistributed consistent with
|
|
this project or the open source license(s) involved.
|
|
```
|
|
|
|
</details>
|
|
|
|
## Issues
|
|
Something went wrong? Not working as expected? The easiest way to report this is through [Issues](https://github.com/hernikplays/freelo-action/issues). Simply fill out the template and I'll get back to you.
|
|
|
|
|