From e3898da78dc39293eab65a3ff897c4e434cd324b Mon Sep 17 00:00:00 2001 From: Isabella Brookes Date: Thu, 30 Apr 2020 23:19:23 +0200 Subject: [PATCH] :pencil: CONTRIBUTING.md created and README.md Updated (#118) * :pencil: Creating the start of a the new CONTRIBUTING.md as mentioned in #116 (#117) * Update issue templates * Update issue templates Resolves #102. * Created a new CONTRIBUTING.md Create the start of a the new CONTRIBUTING.md as mentioned in #116 * Resolved Conflicts and updated Contributing list * Updated missing links to go to correct page and section. Co-authored-by: Isabella Brookes * :pencil: updating a link in README.md Co-authored-by: Matthew Peck-Deloughry --- CONTRIBUTING.md | 42 ++++++++++++++++++++++++++++++++++++++++++ README.md | 41 +++++++---------------------------------- 2 files changed, 49 insertions(+), 34 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..af0394d9 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,42 @@ +# Contributing + +## The Mantra + +We are great believers in open source and the great community that it builds, we feel that is anyone's right to participate in the development of Grüvee, this means everyone should have equal oppertunity to contrubute to the awesome world of open source, and at the same time be treated with the highest levels of respect. + +At the end of the day we're all here to build something awesome, so let's go ahead and make something awesome! + +## 🎉 How to Contribute + +There are multiple ways to contribute to Grüvee, you don't even have to write a single line of code, you can help out by submiting issues, suggesting new features, writing and improving on documentation, fixing bugs or even developing new features. + +### 🐛 Issues and 🎁 Features Requests + +The only way this project will keep growing and getting better is by all of us chipping in to log bugs and suggesting new features! Please utilize [GitHub Issues](https://github.com/PixelogicDev/Gruvee/issues) to report any bugs or add suggestions! + +Don't be scared to join the [PixelogicDev discord](https://discord.gg/ubgX6T8) if you need help. + +### 🔀 Pull Requests + +Now that you are up and running, it's time to push your incredible changes to the Grüvee Repo! For this we will utilize [Pull Requests](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request). + +Make sure all your changes are committed to your forked version of Grüvee and go to [the Grüvee repository](https://github.com/PixelogicDev/Gruvee) and create a Pull Request to merge your changes into the current release branch (ie: `release-1.0`). + +Leave a brief description of your changes, any images/videos of what your new code is doing (if applicable), and any associated GitHub issues. Get ready for some feedback and thank you for contributing! + +> One last thing to note here: if you are a first time contributor and you are not currently on the [Current Contributors List](#current-contributors), please make sure to include a change with adding yourself! The format is as follows: +> +> ``` +> [DesiredName](linkToYourSocial) - Where did you come from? +> ``` + +### ⭐ Current Contributors + +- [@isabellabrookes](https://github.com/isabellabrookes) aka rawrsatbeards - PixelogicDev Channel Moderator +- [poopuhchoo](https://github.com/tjengland) - PixelogicDev Team Member +- [Bastian](https://github.com/BastianInuk) - PixelogicDev Team Member +- [DynamicDonkey](https://github.com/DynamicDonkey) - PixelogicDev Channel Member +- [miugel](https://github.com/miugel) - PixelogicDev Channel Member +- [creativenobu](https://github.com/creativenobu) - PixelogicDev Channel Member +- [rushkiB](https://github.com/maxemiliang) - PixelogicDev Channel Member +- [DR-DinoMight](https://github.com/DR-DinoMight) - PixelogicDev Channel Member diff --git a/README.md b/README.md index 089570f7..2b6fadc5 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ GitHub issues - + PRs welcome!

@@ -20,15 +20,15 @@ · Running Grüvee Locally · - How to Contribute + How to Contribute · - Current Contributors - + Current Contributors + Grüvee is an open source social, collabortive playlist made by the [PixelogicDev Twitch Community](https://twitch.tv/pixelogicdev). This project was entirely made live, on Twitch while receiving help from chat and contributing to Pull Requests here! -If you are interested in becoming a member of the team check out the **[PixelogicDev Twitch](https://twitch.tv/pixelogicdev)**, the **[PixelogicDev Discord](https://discord.gg/ubgX6T8)** and **[contribute](#-how-to-contribute)** to this awesome project! +If you are interested in becoming a member of the team check out the **[PixelogicDev Twitch](https://twitch.tv/pixelogicdev)**, the **[PixelogicDev Discord](https://discord.gg/ubgX6T8)** and **[contribute](CONTRIBUTING.md)** to this awesome project! # MVP Checklist & Timeline For Beta @@ -225,33 +225,6 @@ $ npm run android-start Congratulations! You should now see a beautiful Grüvee mobile app displayed and ready to go! -# 🎉 How to Contribute - -## 🔀 Pull Requests - -Now that you are up and running, it's time to push your incredible changes to the Grüvee Repo! For this we will utilize [Pull Requests](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request). - -Make sure all your changes are committed to your forked version of Grüvee and go to [the Grüvee repository](https://github.com/PixelogicDev/Gruvee) and create a Pull Request to merge your changes into the current release branch (ie: `release-1.0`). - -Leave a brief description of your changes, any images/videos of what your new code is doing (if applicable), and any associated GitHub issues. Get ready for some feedback and thank you for contributing! - -## 🐛 Issues - -The only way this project will keep growing and getting better is by all of us chipping in to log bugs and suggesting new features! Please utilize [GitHub Issues](https://github.com/PixelogicDev/Gruvee/issues) to report any bugs or add suggestions! - -Don't be scared to join the [PixelogicDev discord](https://discord.gg/ubgX6T8) if you need help. - -> One last thing to note here: if you are a first time contributor and you are not currently on the [Current Contributors List](#current-contributors), please make sure to include a change with adding yourself! The format is as follows: -> -> ``` -> [DesiredName](linkToYourSocial) - Where did you come from? -> ``` - -## ⭐Current Contributors +# 🤘 Contributing changes -- [@isabellabrookes](https://github.com/isabellabrookes) aka rawrsatbeards - PixelogicDev Channel Moderator -- [poopuhchoo](https://github.com/tjengland) - PixelogicDev Team Member -- [Bastian](https://github.com/BastianInuk) - PixelogicDev Team Member -- [DynamicDonkey](https://github.com/DynamicDonkey) - PixelogicDev Channel Member -- [miugel](https://github.com/miugel) - PixelogicDev Channel Member -- [creativenobu](https://github.com/creativenobu) - PixelogicDev Channel Member +See [CONTRIBUTING.md](CONTRIBUTING.md)