From cd7d0a123235e27a8288c00d7004b4435ae0a180 Mon Sep 17 00:00:00 2001 From: Stardust Dev <53919399+stardustdev@users.noreply.github.com> Date: Fri, 7 Jul 2023 13:45:34 -0500 Subject: [PATCH] Update README.md --- README.md | 55 +------------------------------------------------------ 1 file changed, 1 insertion(+), 54 deletions(-) diff --git a/README.md b/README.md index 38129ca..f3b4360 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ Develop an elegant React.js Music Application. -Check out the complete project requirements [here](https://docs.google.com/document/d/13PeFwRlPEhMw_HPyrIrInvQuKaVWnpNmcv-y3NA208s/edit?usp=sharing) +You can visit the app [here](https://lyriks-mimic.netlify.app/top-charts) # Contributing @@ -80,57 +80,4 @@ To set up a development environment, please follow these steps: Open [http://localhost:3000](http://localhost:3000) to view it in your browser. -## Issues -You've found a bug in the source code, a mistake in the documentation or maybe you'd like a new feature? You can help us by [submitting an issue on GitHub](https://github.com/orgs/JavaScript-Mastery-PRO/projects/8). Before you create an issue, make sure to search the issue archive -- your issue may have already been addressed! - -Please try to create bug reports that are: - -- _Reproducible._ Include steps to reproduce the problem. -- _Specific._ Include as much detail as possible: which version, what environment, etc. -- _Unique._ Do not duplicate existing opened issues. -- _Scoped to a Single Bug._ One bug per report. - - -## Pull Request - -There are 2 main work flows when dealing with pull requests: - -* Pull Request from a [forked repository](https://help.github.com/articles/fork-a-repo) -* Pull Request from a branch within a repository - -Here we are going to focus on 2. Creating a Topical Branch: - - -1. First, we will need to create a branch from the latest commit on master. Make sure your repository is up to date first using - - ```bash - git pull origin main - ``` - - *Note:* `git pull` does a `git fetch` followed by a `git merge` to update the local repo with the remote repo. For a more detailed explanation, see [this stackoverflow post](http://stackoverflow.com/questions/292357/whats-the-difference-between-git-pull-and-git-fetch). - -2. To create a branch, use `git checkout -b []`, where `base-branch-name` is optional and defaults to `main`. - - Use a standard convention for branch names. For example, `-dev`. It will be easier to track your pull requests if you use this convention. - - I'm going to create a new branch called `jsm-dev` from the `main` branch and push it to github. - - ```bash - git checkout -b jsm-dev main - git push origin jsm-dev - ``` - -3. To create a pull request, you must have changes committed to your new branch. - -4. Go to [Pull Requests](https://github.com/JavaScript-Mastery-PRO/project1_team4_repository/pulls) and click on the `New Pull Request` button. - -5. Select the `main` branch as the `base` branch and the `jsm-dev` branch as the `compare` branch. - -6. Follow the template and fill in the proper information for the pull request. - -7. Click on the `Submit` button. - -8. You have successfully created a pull request. Now wait for mentor approval. Once approved, you can merge the pull request. - -#