You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
VRMS is governed by the [Hack for LA Code of Conduct](https://www.hackforla.org/code-of-conduct/) which applies to any interaction on our VRMS slack channel (inside the HackforLA Slack workspace), direct slack messages, github org or repository, or any other communication medium.
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+69-64Lines changed: 69 additions & 64 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,6 @@
3
3
4
4
<p>This document outlines the process for joining our team and contributing to the VRMS Github repository. If you notice errors or have important information to add, please feel free to propose changes to this document with a pull request</p>
5
5
6
-
7
6
<h2>Table of Contents</h2>
8
7
9
8
-[**Part 1 : How to join the team**](#part-1--how-to-join-the-team)
@@ -24,15 +23,16 @@
24
23
-[**4.1 Push changes to your forked repository**](#41-push-changes-to-your-forked-repository)
25
24
-[**4.2 Create a pull request on the VRMS repository**](#42-create-a-pull-request-on-the-vrms-repository)
26
25
27
-
28
26
## **Part 1 : How to join the team**
29
27
30
28
### **1.1 VRMS contributor expectations**
29
+
31
30
- Attend at least 1 team meeting per week
32
31
- Devote a minimum of 6 hours per week to working on VRMS assignments
33
32
- Communicate with the team leadership if you plan to step away from the project
34
33
35
34
### **1.2 Reach out to us on Slack**
35
+
36
36
If you would like to contribute to our project, please reach out to the team leads on Slack or at one of our weekly meetings. You can find the current project team, their slack links, and our team meeting times on the [VRMS Project Details Page](https://www.hackforla.org/projects/vrms).
37
37
38
38
### **1.3 Become a member of the repository Team**
@@ -50,15 +50,16 @@ These steps are manditory in order to contribute to all HackforLA projects.
50
50
## **Part 2: How to set up the development environment**
51
51
52
52
### **2.1 Fork the repository**
53
-
*A fork is a copy of the repository that will be placed on your GitHub account url.*
54
53
55
-
* In https://github.com/hackforla/VRMS, look for the fork icon in the top right. Click it and create a fork of the repository.
54
+
_A fork is a copy of the repository that will be placed on your GitHub account url._
55
+
56
+
- In https://github.com/hackforla/VRMS, look for the fork icon in the top right. Click it and create a fork of the repository.
56
57
57
-
* It should create a copy here: https://github.com/YOUR_GITHUB_USERNAME/vrms, where `YOUR_GITHUB_USERNAME` is replaced with your github username.
58
+
- It should create a copy here: https://github.com/YOUR_GITHUB_USERNAME/vrms, where `YOUR_GITHUB_USERNAME` is replaced with your github username.
58
59
59
60
> NOTE: This copy is on a remote server on the GitHub website and not on your computer yet.
60
61
61
-
* Click the icon again, it will give you the URL associated with your forked repository and not create a new fork.
62
+
- Click the icon again, it will give you the URL associated with your forked repository and not create a new fork.
62
63
63
64
### **2.2 Clone the remote repository to your local computer**
64
65
@@ -67,39 +68,42 @@ The following process will make a copy of the fork that you just created on your
67
68
1. Create a new folder on your local computer that will contain `hackforla` projects.
68
69
69
70
2. In your shell (terminal), navigate to this folder then run the following commands:
Note: Understanding how git remotes work will make collaborating much easier. You can learn more about remotes [here](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/configuring-a-remote-for-a-fork) and [here](https://git-scm.com/book/en/v2/Git-Basics-Working-with-Remotes).
100
105
101
-
102
-
### **2.3 Get up and running**
106
+
### **2.3 Get up and running**
103
107
104
108
1. Have [Node](https://nodejs.org/en/download/) and NPM installed locally:
105
109
@@ -128,7 +132,7 @@ Note: Understanding how git remotes work will make collaborating much easier. Yo
128
132
129
133
Note 2: `touch` is a Unix/Linux or Mac command; It is not available in Windows. In Windows, use a text editor (e.g. Notepad) to create an empty file and save it in each of the locations as `.env` . (If you use Windows Explorer to create the file it will create a file called `.env.txt`, which will not work.)
130
134
131
-
- Then paste the content from the [document](https://docs.google.com/document/d/1PdcZhyo2a2lr0JNcgyzpWi98tGkZeH1Zxz-Jnf6JQDU/edit?usp=sharing). It is accessible for the project team members only.
135
+
- Then paste the content from the [document](https://docs.google.com/document/d/1PdcZhyo2a2lr0JNcgyzpWi98tGkZeH1Zxz-Jnf6JQDU/edit?usp=sharing). It is accessible for the project team members only.
132
136
133
137
-_Please note that the `ports` for the frontend and backend are set in this location_
134
138
@@ -140,16 +144,15 @@ Note: Understanding how git remotes work will make collaborating much easier. Yo
140
144
141
145
- Navigate to the root of the application `vrms/` and run `yarn start`
142
146
143
-
*Troubleshooting :* If you encounter the following error after running `yarn start`:
Try changing your node version to `16.14.2` by running `nvm use 16.14.2`. If you do not have `nvm` installed, see [install instructions](https://github.com/nvm-sh/nvm#installing-and-updating)
147
+
_Troubleshooting :_ If you encounter the following error after running `yarn start`:
Try changing your node version to `16.14.2` by running `nvm use 16.14.2`. If you do not have `nvm` installed, see [install instructions](https://github.com/nvm-sh/nvm#installing-and-updating)
152
154
155
+
You should now have a live app. Happy hacking.
153
156
154
157
### **2.4 Running Tests**
155
158
@@ -166,66 +169,68 @@ To view and edit the development database manually, you can download [MongoDB Co
166
169
167
170
If you want to install a local copy to experiment with and learn more about MongoDB, you can use [this tutorial](https://zellwk.com/blog/local-mongodb/)
168
171
169
-
170
-
171
172
## **Part 3: How to work on issues**
172
173
173
-
174
174
### **3.1 Claim an Issue**
175
175
176
-
Developers may assign themselves to issues from the [Prioritized Backlog column](https://github.com/hackforla/VRMS/projects/12#column-19074778) of the project board.
176
+
Developers may assign themselves to issues from the [Prioritized Backlog column](https://github.com/orgs/hackforla/projects/72/views/1?filterQuery=backlog) of the project board.
177
177
178
178
The Prioritized Backlog column is filtered so the first (top) issue has the highest priority and should be worked on next if possible.
179
179
180
180
Developers may choose from issues with the following `role` labels:
181
+
181
182
-`role: Front End`
182
183
-`role: Back End`
183
184
-`role: Database`
184
185
185
186
Claiming an issue is a two step process:
187
+
186
188
1. Assign yourself to the issue using the gear icon in the upper right corner of the issue where it says "Assignees"
187
189
2. Move the issue from the `Prioritized Backlog` to the `In Progress` column of the project board
188
190
189
-
190
191
### **3.2 Create a new branch for each issue you work on**
191
-
You will create a new branch for each issue you work on. Doing all your work on feature branches leaves your repository's main branch unmodified and greatly simplifies keeping your fork in sync with the main project.
192
192
193
+
You will create a new branch for each issue you work on. Doing all your work on feature branches leaves your repository's main branch unmodified and greatly simplifies keeping your fork in sync with the main project.
193
194
194
-
1. Before creating a new branch, always make sure you are currently on the `development` branch by using the command
195
-
```bash
196
-
git branch
197
-
```
195
+
1. Before creating a new branch, always make sure you are currently on the `development` branch by using the command
196
+
```bash
197
+
git branch
198
+
```
198
199
2. Before creating a new branch, always pull down the latest changes from the `development` branch by using the command
199
-
```bash
200
-
git pull vrms development
201
-
```
200
+
```bash
201
+
git pull vrms development
202
+
```
202
203
3. Finally, create a new branch where you will work on your issue by using the command:
203
-
```bash
204
-
git checkout -b your-branch-name
205
-
```
204
+
```bash
205
+
git checkout -b your-branch-name
206
+
```
206
207
207
208
### **3.3 Work on the Issue**
208
-
Every issue will contain action items you must complete before you are ready to submit a pull request. Be sure to use the checkboxes as you complete each action item so we can track your progress!
209
209
210
+
Every issue will contain action items you must complete before you are ready to submit a pull request. Be sure to use the checkboxes as you complete each action item so we can track your progress!
210
211
211
212
After you have completed the action items, add and commit the changes to your new branch using the commands
213
+
212
214
```
213
215
git add .
214
216
git commit -m "your commit message"
215
-
```
216
-
217
+
```
217
218
218
219
## **Part 4: How to create pull requests**
220
+
219
221
### **4.1 Push changes to your forked repository**
222
+
220
223
1. Before pushing code, always pull down the latest changes from the `development` branch by using the command
221
-
```
222
-
git pull vrms development
223
-
```
224
+
```
225
+
git pull vrms development
226
+
```
224
227
2. Once you are satisfied with your changes, push them to the feature branch you made within your remote repository.
225
-
```
226
-
git push --set-upstream origin your-branch-name
227
-
```
228
+
```
229
+
git push --set-upstream origin your-branch-name
230
+
```
231
+
228
232
### **4.2 Create a pull request on the VRMS repository**
233
+
229
234
1. Go to your fork of the VRMS repository on GitHub and click on the `Compare & pull request` button. <details><summary>See screenshot</summary> <imgsrc="https://user-images.githubusercontent.com/73561520/220488394-09bc759e-98d9-4a09-86c6-66378cf50923.png"/></details>
230
235
2. Be sure to title your pull request by summarizing the changes you made
231
236
3. Be sure to add your issue number where the template says `Fixes #replace_this_text_with_the_issue_number`
0 commit comments