From 06155692de196fb438d76bd84faa4862b6bd134d Mon Sep 17 00:00:00 2001 From: Alicia Sykes Date: Sun, 3 Oct 2021 21:44:42 +0100 Subject: [PATCH] :memo: Updates development docs --- docs/contributing.md | 2 +- docs/developing.md | 12 +++++++----- 2 files changed, 8 insertions(+), 6 deletions(-) diff --git a/docs/contributing.md b/docs/contributing.md index 8a7841a4..fe765cc7 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -111,5 +111,5 @@ For a full list of Dashy's contributors, see the [Credits Page](/docs/credits.md ### Star-Gazers Over Time -![Stargazers](https://starchart.cc/Lissy93/dashy.svg) +[![Stargazers](https://starchart.cc/Lissy93/dashy.svg)](https://seladb.github.io/StarTrack-js/#/preload?r=Lissy93,dashy) diff --git a/docs/developing.md b/docs/developing.md index 17649f3d..0efc497f 100644 --- a/docs/developing.md +++ b/docs/developing.md @@ -84,11 +84,13 @@ You can set the environment using the `NODE_ENV` variable. By default, the corre ### Git Flow Like most Git repos, we are following the [Github Flow](https://guides.github.com/introduction/flow) standard. -1. Create a branch (or fork if you don'd have write acces) -2. Code some awesome stuff, then add and commit your changes -3. Create a Pull Request, complete the checklist and ensure the build succeeds -4. Follow up with any reviews on your code -5. Merge 🎉 +1. Create a branch (or fork if you don'd have write access) +2. Code some awesome stuff 🧑‍💻 +3. Add, commit and push your changes to your branch/ fork +4. Head over to GitHub and create a Pull Request +5. Fill in the required sections in the template, and hit submit +6. Follow up with any reviews on your code +7. Merge 🎉 ### Git Branch Naming The format of your branch name should be something similar to: `[TYPE]/[TICKET]_[TITLE]`