MovieDo🧙🏻♂️ 🧙🏻♀️ "Get movie reviews at a click 🎯"
🎯 If you are a beginner, and looking for your first contribution, we are here to help. Just append your favorite movie, its rating and its short description in our
https://github.com/garimasingh128/Hacktoberfest2020-MovieDo/tree/master/src/data/data.json
and that counts as your first PR. 🎯
- 🎯Open the
src/data/data.jsonfile in your code editor of choice. - 🎯Add another json object in the same format of your favourite movie
- 🎯Save your changes.
- 🎯The movie card will appear on your homepage at
http://localhost:8000! - 🎯Done! Ready to create your pull request?
🙅🏼♂️Hacktoberfest is open to everyone in our global community. Whether you’re new to development, a student, long-time contributor, event host, or company of any size, you can help drive growth of open source and make positive contributions to an ever-growing community. All backgrounds and skills levels are encouraged to complete the challenge.🙅🏼♂️
💻 Also, our website is open to contributions from both frontend and designer fellows who want to help us in making it bigger and better.
💻 Make all Pull requests to the "develop" branch only. Let's maintain a stable master branch that is deployed. Changes would be merged later on to the master branch.
Link to register: https://hacktoberfest.digitalocean.com/
See Our Website at: https://hacktoberfest.netlify.com/
Read the Instructions and click Done at the end to move to the repository or click here to head to the repository.
GitHub repository URLs will reference both the username associated with the owner of the repository, as well as the repository name.
When you’re on the main page for the repository, you’ll see a button to "Star" and “Fork” the repository on your upper right-hand side of the page, underneath your user icon.
To make your own local copy of the repository you would like to contribute to, let’s first open up a terminal window.
This URL will be similar to the URL above, except now it will end with .git. In the example above, the URL will look like this:
https://github.com/your-username/Hacktoberfest2020-MovieDo.git
You can alternatively copy the URL by using the green “Clone or download” button from your repository page that you just forked from the original repository page. Once you click the button, you’ll be able to copy the URL by clicking the binder button next to the URL.
Once we have the URL, we’re ready to clone the repository. To do this, we’ll combine the git clone command with the repository URL from the command line in a terminal window:
git clone https://github.com/your-username/Hacktoberfest2020-MovieDo.git
To create your branch, from your terminal window, change your directory so that you are working in the directory of the repository. Be sure to use the actual name of the repository (i.e. Hacktoberfest2020-MovieDo) to change into that directory.
Now, we’ll create our new branch with the git branch command. Make sure you name it descriptively so that others working on the project understand what you are working on.
Now that our new branch is created, we can switch to make sure that we are working on that branch by using the git checkout command:
At this point, you can now modify existing files or add new files to the project on your own branch.
Make sure you have read the contributing.md before you start contributing such that you make remarkable and easily acceptable PRs.
CAUTION: JSON files follow a certain format, do not forget to add a comma before you start editing your block and it's good if you append a comma after finishing your block.
Also, if you are interested in making intermediate or advanced level contributions, head to our intermediate section and make your mark.
Once you have modified existing files or added new files to the project, you can add them to your local repository, which you can do with the git add command. Let’s add the -A flag to add all changes that we have made:
The commit message is an important aspect of your code contribution; it helps the other contributors fully understand the change you have made, why you made it, and how significant it is. Additionally, commit messages provide a historical record of the changes for the project at large, helping future contributors along the way. Thus, you must ensure that you write a meaningful commit message. If in a confusion, refer to the good contribution guidelines included in the ##### contributing.md
At this point you can use the git push command to push the changes to the current branch of your forked repository:
While working on a project alongside other contributors, it is important for you to keep your local repository up-to-date with the project as you don’t want to make a pull request for code that will cause conflicts. To keep your local copy of the code base updated, you’ll need to sync changes.
Next, you’ll have to specify a new remote upstream repository for us to sync with the fork. This will be the original repository that you forked from. you’ll have to do this with the git remote add command.
In this example, // upstream // is the shortname we have supplied for the remote repository since in terms of Git, “upstream” refers to the repository that you cloned from. If you want to add a remote pointer to the repository of a collaborator, you may want to provide that collaborator’s username or a shortened nickname for the shortname.
Once you have configured a remote that references the upstream and original repository on GitHub, you are ready to sync your fork of the repository to keep it up-to-date.
To sync your fork, from the directory of your local repository in a terminal window, you’ll have to use the // git fetch // command to fetch the branches along with their respective commits from the upstream repository. Since you used the shortname “upstream” to refer to the upstream repository, you’ll have to pass that to the command:
Now merge any changes that were made in the original repository’s master branch, that you will access through your local upstream/master branch, with your local master branch:
At this point, you are ready to make a pull request to the original repository. Make PRs' to the develop branch only!
Now navigate to your forked repository, and press the “New pull request” button on your left-hand side of the page.
https://hacktoberfest.digitalocean.com/profile
The project can run in any frontend web environment, but the quickest way to try it out is by running it on a pre-configured starter site with Netlify. Use the button below to build and deploy your own copy of the repository: 🙅🏼♂️
- 👓After clicking that button, you’ll authenticate with GitHub and choose a repository name.
- 👓Netlify will then automatically create a repository in your GitHub account with a copy of the files from the template.
- 👓It will build and deploy the new site on Netlify, bringing you to the site dashboard when the build is complete.
Garima Singh
👩🎓 Junior | 💻 Aspiring Software Developer | 📲 Shipping code since 2018 | Open-Source Mentor 💜 | DevRel 🌤️
The MIT License (MIT)
Copyright (c) 2020 Garima Singh MovieDo
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.