ayo/mcfly
ayo/mcfly
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

chore: add contribution section in readme

Browse source
This commit is contained in:
Ayo Ayco 2025-03-01 12:09:58 +01:00
parent 2e8211c2ad
commit 7750ac8d73
2 changed files with 17 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
CONTRIBUTING.md
View file

@ -3,6 +3,7 @@
Hi, and thanks for your interest to contribute to **McFly**! 🎉
This guide is the best place to start if you want to contribute to the project. You can do so by any of the following:
1. [Report issues or request features](#report-issues-or-request-features)
1. [Participate in discussions](#participate-in-discussions)
1. [Contribute code](#contribute-code)
@ -25,22 +26,26 @@ To get started, setup [git send-email](https://git-send-email.io).
After setting up `git send-email` you can now follow the steps below to start hacking:
1️⃣ Clone the repository to your local machine, then go into the project directory:
```bash
$ git clone https://git.sr.ht/~ayoayco/mcfly
$ cd mcfly
```
2️⃣ Create a new branch for your changes:
```bash
$ git checkout -b my-branch
```
3️⃣ Make your changes, and then commit them with a descriptive message using [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/):
```bash
$ git commit -m "feat(core): implement server-side rendering"
```
4️⃣ Use `git send-email` to send a patch:
```bash
$ git send-email --to="~ayoayco/mcfly-patches@lists.sr.ht" HEAD^
```
@ -48,6 +53,7 @@ $ git send-email --to="~ayoayco/mcfly-patches@lists.sr.ht" HEAD^
### Tips:
💡 You can set the default "to" address for the project:
```bash
$ git config sendemail.to "~ayoayco/mcfly-patches@lists.sr.ht"
```
@ -58,7 +64,6 @@ $ git config sendemail.to "~ayoayco/mcfly-patches@lists.sr.ht"
> As a summary, we use `git` and `email` to collaborate on McFly. You have to set up [git send-email](https://git-send-email.io) and send patches via email. :)
## Get in touch
If something needs clarification, or even if you just want to chat about the project, don't hesitate to reach out to me via email [`ayo@ayco.io`](mailto:ayo@ayco.io). Thanks! :)
If something needs clarification, or even if you just want to chat about the project, don't hesitate to reach out to me via email [`ayo@ayco.io`](mailto:ayo@ayco.io). Thanks! :)

10
README.md
View file

@ -48,6 +48,16 @@ It is primarily a runtime middleware for [Nitro](https://nitro.build). Every tim
A plugin system allows for the core functionality to only "lean" on platform. Anything not yet a standard is implemented as a plugin which will be easily "swapped" away when the platform catches up.
## Contribution
There is [a guide for contributing via SourceHut](https://git.sr.ht/~ayoayco/mcfly/tree/main/item/CONTRIBUTING.md).
But you can also contribute via official mirrors of the project repository in the following platforms:
1. [McFly @ GitHub](https://github.com/ayoayco/mcfly)
We will add more guides & mirrors for different platforms.
## Features
✅ Use vanilla custom elements (or sugar-coated web components)<br>