|
| 1 | +# Project Lyrics |
| 2 | + |
| 3 | +Develop an elegant React.js Music Application. |
| 4 | + |
| 5 | +Check out the complete project requirements [here](https://docs.google.com/document/d/13PeFwRlPEhMw_HPyrIrInvQuKaVWnpNmcv-y3NA208s/edit?usp=sharing) |
| 6 | + |
| 7 | +# Contributing |
| 8 | + |
| 9 | +When contributing to this repository, please first discuss the change you wish to make via issue. |
| 10 | +Please note we have a [code of conduct](CODE_OF_CONDUCT.md), please follow it in all your interactions with the project. |
| 11 | + |
| 12 | + |
| 13 | +## System Requirements |
| 14 | + |
| 15 | +To get started with development, you need to install few tools |
| 16 | + |
| 17 | +1. git |
| 18 | + |
| 19 | + `git` version 2.13.1 or higher. Download [git](https://git-scm.com/downloads) if you don't have it already. |
| 20 | + |
| 21 | + To check your version of git, run: |
| 22 | + |
| 23 | + ```shell |
| 24 | + git --version |
| 25 | + ``` |
| 26 | + |
| 27 | +2. node |
| 28 | + |
| 29 | + `node` version 16.15.1 or higher. Download [node](https://nodejs.org/en/download/) if you don't have it already. |
| 30 | + |
| 31 | + To check your version of node, run: |
| 32 | + |
| 33 | + ```shell |
| 34 | + node --version |
| 35 | + ``` |
| 36 | + |
| 37 | +3. npm |
| 38 | + |
| 39 | + `npm` version 5.6.1 or higher. You will have it after you install node. |
| 40 | + |
| 41 | + To check your version of npm, run: |
| 42 | + |
| 43 | + ```shell |
| 44 | + npm --version |
| 45 | + ``` |
| 46 | + |
| 47 | +## Setup |
| 48 | + |
| 49 | +To set up a development environment, please follow these steps: |
| 50 | + |
| 51 | +1. Clone the repo |
| 52 | + |
| 53 | + ```shell |
| 54 | + git clone https://github.com/JavaScript-Mastery-PRO/project1_team4_repository.git |
| 55 | + ``` |
| 56 | + |
| 57 | +2. Change directory to the project directory |
| 58 | + |
| 59 | + ```shell |
| 60 | + cd project1_team4_repository |
| 61 | + ``` |
| 62 | + |
| 63 | +3. Install the dependencies |
| 64 | + |
| 65 | + ```shell |
| 66 | + npm install |
| 67 | + ``` |
| 68 | + |
| 69 | + If you get an error, please check the console for more information. |
| 70 | + |
| 71 | + If you don't get an error, you are ready to start development. |
| 72 | +
|
| 73 | +4. Run the app |
| 74 | + |
| 75 | + ```shell |
| 76 | + npm run dev |
| 77 | + ``` |
| 78 | +
|
| 79 | + Project will be running in the browser. |
| 80 | +
|
| 81 | + Open [http://localhost:3000](http://localhost:3000) to view it in your browser. |
| 82 | +
|
| 83 | +## Issues |
| 84 | +
|
| 85 | +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! |
| 86 | +
|
| 87 | +Please try to create bug reports that are: |
| 88 | +
|
| 89 | +- _Reproducible._ Include steps to reproduce the problem. |
| 90 | +- _Specific._ Include as much detail as possible: which version, what environment, etc. |
| 91 | +- _Unique._ Do not duplicate existing opened issues. |
| 92 | +- _Scoped to a Single Bug._ One bug per report. |
| 93 | +
|
| 94 | +
|
| 95 | +## Pull Request |
| 96 | +
|
| 97 | +There are 2 main work flows when dealing with pull requests: |
| 98 | +
|
| 99 | +* Pull Request from a [forked repository](https://help.github.com/articles/fork-a-repo) |
| 100 | +* Pull Request from a branch within a repository |
| 101 | +
|
| 102 | +Here we are going to focus on 2. Creating a Topical Branch: |
| 103 | +
|
| 104 | +
|
| 105 | +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 |
| 106 | +
|
| 107 | + ```bash |
| 108 | + git pull origin main |
| 109 | + ``` |
| 110 | +
|
| 111 | + *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). |
| 112 | +
|
| 113 | +2. To create a branch, use `git checkout -b <new-branch-name> [<base-branch-name>]`, where `base-branch-name` is optional and defaults to `main`. |
| 114 | + |
| 115 | + Use a standard convention for branch names. For example, `<your-name>-dev`. It will be easier to track your pull requests if you use this convention. |
| 116 | + |
| 117 | + I'm going to create a new branch called `jsm-dev` from the `main` branch and push it to github. |
| 118 | + |
| 119 | + ```bash |
| 120 | + git checkout -b jsm-dev main |
| 121 | + git push origin jsm-dev |
| 122 | + ``` |
| 123 | + |
| 124 | +3. To create a pull request, you must have changes committed to your new branch. |
| 125 | + |
| 126 | +4. Go to [Pull Requests](https://github.com/JavaScript-Mastery-PRO/project1_team4_repository/pulls) and click on the `New Pull Request` button. |
| 127 | + |
| 128 | +5. Select the `main` branch as the `base` branch and the `jsm-dev` branch as the `compare` branch. |
| 129 | + |
| 130 | +6. Follow the template and fill in the proper information for the pull request. |
| 131 | + |
| 132 | +7. Click on the `Submit` button. |
| 133 | + |
| 134 | +8. You have successfully created a pull request. Now wait for mentor approval. Once approved, you can merge the pull request. |
| 135 | + |
| 136 | +# |
0 commit comments