Skip to content

Commit

Permalink
📝 CONTRIBUTING.md created and README.md Updated (#118)
Browse files Browse the repository at this point in the history
* 📝 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 <[email protected]>

* 📝 updating a link in README.md

Co-authored-by: Matthew Peck-Deloughry <[email protected]>
  • Loading branch information
isabellabrookes and DR-DinoMight authored Apr 30, 2020
1 parent 8b84263 commit e3898da
Show file tree
Hide file tree
Showing 2 changed files with 49 additions and 34 deletions.
42 changes: 42 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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
41 changes: 7 additions & 34 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
<a href="https://github.com/pixelogicdev/gruvee">
<img alt="GitHub issues" src="https://img.shields.io/github/issues/pixelogicdev/gruvee-mobile">
</a>
<a href="#-how-to-contribute">
<a href="CONTRIBUTING.md#-how-to-contribute">
<img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg" alt="PRs welcome!" />
</a>
</p>
Expand All @@ -20,15 +20,15 @@
<span> · </span>
<a href="#running-grüvee-locally">Running Grüvee Locally</a>
<span> · </span>
<a href="#-how-to-contribute">How to Contribute</a>
<a href="CONTRIBUTING.md#-how-to-contribute">How to Contribute</a>
<span> · </span>
<a href="#current-contributors">Current Contributors</a>
<a href="CONTRIBUTING.md#current-contributors">Current Contributors</a>

</h3>

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

Expand Down Expand Up @@ -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)

0 comments on commit e3898da

Please sign in to comment.