diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e889a20..514fc2c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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: -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 $ git clone https://git.sr.ht/~ayoayco/mcfly $ cd mcfly ``` -2. Create a new branch for your changes: +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/): +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: +4️⃣ Use `git send-email` to send a patch: ```bash 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. -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. :)