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

chore: add emoji numerics to steps in the contributing guide

Browse source
This commit is contained in:
Ayo Ayco 2025-02-10 22:39:44 +01:00
parent 5f0cff2ade
commit bf40df6d54
1 changed files with 5 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
CONTRIBUTING.md
View file

@ -24,26 +24,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: 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: 1️⃣ Clone the repository to your local machine, then go into the project directory:
```bash ```bash
$ git clone https://git.sr.ht/~ayoayco/mcfly $ git clone https://git.sr.ht/~ayoayco/mcfly
$ cd mcfly $ cd mcfly
``` ```
2. Create a new branch for your changes: 2️⃣ Create a new branch for your changes:
```bash ```bash
git checkout -b my-branch 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/): 3️⃣ Make your changes, and then commit them with a descriptive message using [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/):
```bash ```bash
git commit -m "feat(core): implement server-side rendering" git commit -m "feat(core): implement server-side rendering"
``` ```
4. Use `git send-email` to send a patch: 4️⃣ Use `git send-email` to send a patch:
```bash ```bash
git send-email --to="~ayoayco/mcfly-patches@lists.sr.ht" HEAD^ git send-email --to="~ayoayco/mcfly-patches@lists.sr.ht" HEAD^
@ -51,7 +51,7 @@ git send-email --to="~ayoayco/mcfly-patches@lists.sr.ht" HEAD^
> 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. > 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. Wait for a response from us whether the patch needs rework... or a notification if it gets merged! 5️⃣ 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. :) > 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. :)