chore: separate items for html routing & templating
This commit is contained in:
parent
fc18f3611b
commit
785e08008b
4 changed files with 4 additions and 53 deletions
|
|
@ -1,4 +0,0 @@
|
||||||
# Rough list of changes
|
|
||||||
|
|
||||||
1. Expose a `McFly` object containing event properties to `server:setup` scripts. Useful for handling requests like form submission.
|
|
||||||
2. Add a cozy demo page for form handling using the exposed `McFly` object
|
|
||||||
|
|
@ -19,50 +19,7 @@ To start or participate on discussions, see our [mcfly-discussions](https://list
|
||||||
|
|
||||||
## Contribute Code
|
## Contribute Code
|
||||||
|
|
||||||
We use `git` and `email` here -- it is actually fun!
|
Due to still figuring out how parts fit together, we are not ready for code contributions.
|
||||||
|
|
||||||
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.ayo.run/ayo/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^
|
|
||||||
```
|
|
||||||
|
|
||||||
### Tips:
|
|
||||||
|
|
||||||
💡 You can set the default "to" address for the project:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
$ git config sendemail.to "~ayoayco/mcfly-patches@lists.sr.ht"
|
|
||||||
```
|
|
||||||
|
|
||||||
💡 The `HEAD^` bit is a reference to the latest commit, which will be added to your patch. This could be a range of commits as well if you have mutiple commits.
|
|
||||||
|
|
||||||
5️⃣ After successfully sending your patch, wait for a response from us whether the patch needs rework... or a notification if it gets merged!
|
|
||||||
|
|
||||||
> 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
|
## Get in touch
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -30,10 +30,11 @@ I thought:
|
||||||
We are currently in a focused rewrite. All parts are subject to breaking changes in minor releases.
|
We are currently in a focused rewrite. All parts are subject to breaking changes in minor releases.
|
||||||
|
|
||||||
- [x] file-based API routing via fastify as server framework
|
- [x] file-based API routing via fastify as server framework
|
||||||
- [ ] file-based HTML pages routing & templating via Eta
|
- [ ] file-based HTML pages routing
|
||||||
|
- [ ] HTML templating via Eta
|
||||||
- [ ] auto-registry of custom elements
|
- [ ] auto-registry of custom elements
|
||||||
- [ ] SSR custom elements
|
- [ ] SSR custom elements
|
||||||
- [ ] SSG
|
- [ ] SSG builds
|
||||||
|
|
||||||
## Try it today
|
## Try it today
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,3 +0,0 @@
|
||||||
# Values (initial)
|
|
||||||
|
|
||||||
Our core values include leaning on open standards and decentralized technologies, which do not require any form of lock-in. Therefore, you don’t need anything else than `git` and `email` to collaborate.
|
|
||||||
Loading…
Reference in a new issue