Skip to content

Commit e8b80ed

Browse files
committed
Update contributing section
1 parent 71136ac commit e8b80ed

File tree

1 file changed

+5
-12
lines changed

1 file changed

+5
-12
lines changed

README.md

+5-12
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,7 @@ Geolocation-based web app for locating schools and school districts near you.
44

55

66
### Phase 1
7-
* Frontend
8-
* [ ] Single page site
9-
* [ ] Landing page
10-
* [ ] Reverse geocode address into lat lon location
11-
* [ ] Show school district for a given lat lon location
12-
* [ ] Show closest schools to a given lat lon location (restricted by school district?)
13-
* Data/backend
14-
* [ ] Static JSON dataset for school districts and schools suitable for identifying school districts and schools via distance calculations
15-
* [ ] Tools for generating dataset(s)
16-
* Deployment
17-
* [ ] Hosting of site and data (s3?)
18-
* [ ] Automated data update/ingest (?)
7+
See issues for things that need to be done.
198

209
### Phase 2
2110
TBD
@@ -43,6 +32,10 @@ TBD
4332

4433
If you would like to contribute code, just fork the repository and work on a new branch. You can submit a pull request to our repository and a member of Code for OKC will approve and merge it.
4534

35+
To work on a specific feature:
36+
* if it is a service - create a new file for your service in the services folder and include your service code in it. Also include some sort of test code, whether it is full blown unit tests or just example integration code (ie a simple page using the service). Also include some documentation with your service in the form of comments. Make a PR.
37+
* if it affects the main app logic - update the app itself. Make a PR
38+
4639
## Copyright and license
4740

4841
Copyright 2014 Code for OKC. Licensed under the MIT License.

0 commit comments

Comments
 (0)