hasykes / rebus

🌟 👣 Take your first steps as an open source contributor

Rebus

Contributing to an open source project for the first time can be a scary thing. The goal of this repo is to help you take your first steps as an open source contributor by developing a simple (but hopefully fun) rebus game together. 💖

Try the live version of the game: https://ollelauribostrom.github.io/rebus/

Who can contribute?

Everyone can! (and I mean everyone) 💫

💻 You don’t have to contribute code. Add a new rebus, fix a typo, report a bug, add some documentation, do some re-design or add a translation. This project just like most open source projects are in need of all sorts of different contributions. Not just code.

🌟 You are good enough. Start of easy by fixing something small (like adding a new rebus). This will help you orientate yourself in the project and increase your confidence and experience. No one will judge you if you make a mistake and you can't break anything. Ask for some pointers if you get stuck. You got this!

➡️ Have a look at the open issues to see what needs to be done in this project.

The only thing that is required to get started is git. Make sure you have it installed on your computer by running git --version in your terminal. If you do not have git installed, install it.

Fork this repo

The first step is to create a fork of this repo. Do so by clicking on the fork button on the top of this page. A fork is basically your own working copy of this repository.

Clone the repo

The next step is to clone the forked repo to your machine.

Go to your GitHub repositories and open the forked repository called Rebus (forked from ollelauribostrom/rebus). Then click on the "Clone or download" button and then click the copy to clipboard icon to get your url.

Finally run the following git command in your terminal:

git clone "the copied url"

For example:

git clone https://github.com/username/rebus.git

You have now created a local clone on you computer. Good job!

Create a branch

It's common practice to create a new branch for each new feature of bugfix you are working on. Let's go ahead and create one.

If you haven't already, start by changing your directory to the rebus catalog that was created when you ran git clone:

cd rebus

Create your new branch by running:

git checkout -b <your-new-branch-name>

Note: Replace <your-new-branch-name> with something that describes the changes you are about to make

For example:

git checkout -b add-new-rebus

Make your changes

Now it's time to make your changes. Let's add a new rebus to the game.

Open the file src/js/rebuses.js in your favourite editor and add a new rebus object to the end of the rebuses array. Save the file and then run git --status to see which changes you have made. This will look something like:

To add these changes to your next commit, you can run:

git add src/js/rebuses.js

To commit your changes, run:

git commit -m "Your message"

For example:

git commit -m "Adding a new rebus"

Push your changes to Github

Push your changes to GitHub by running:

git push origin <your-new-branch-name>

Note: Replace <your-new-branch-name> with the name of your branch

Open a Pull Request

Head over to your repository on GitHub and click on the green "Compare and pull request" button.

Describe your changes and submit your pull request

What's next?

Great work! 🎉🎉🎉🎉

You just took your first step as an open source contributor. I'll review your pull request as soon as possible. Join us on gitter if you have questions or need further help.

Support

Please open an issue for support, or join us on gitter.

License

Licensed under the MIT License.