Skip to content

Commit 62a7c3f

Browse files
committed
Update readme
Test coverage and contribution guide
1 parent 68b3167 commit 62a7c3f

File tree

1 file changed

+44
-0
lines changed

1 file changed

+44
-0
lines changed

README.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -161,3 +161,47 @@ var myGeopoint = {
161161
var batman = geopoint.modelate(myGeopoint);
162162
console.log(batman);
163163
```
164+
165+
# Tests
166+
167+
I'm currently adding tests to this code. I'm using Jasmine, and saving tests in `/spec` folder.
168+
169+
To run tests, just execute:
170+
```
171+
npm test
172+
```
173+
174+
First time you run tests, you might need to install Jasmine, and other possible test dependencies. To do it fastly, just execute:
175+
```
176+
npm install
177+
```
178+
179+
And now you can run tests ^^
180+
181+
## Test coverage:
182+
Master version might not have the last test updates. Check out the `develop` branch to see the last updates. Also, the actual test coverage (in `develop` branch) is fully referenced in #3 issue.
183+
184+
- [ ] Core
185+
- [x] Exported module
186+
- [x] Model
187+
- [x] Modelate
188+
- [ ] Validate
189+
- [ ] Validators
190+
- [ ] Type
191+
- [ ] Length
192+
- [ ] Value
193+
- [ ] Custom function
194+
- [ ] Date
195+
- [ ] Model
196+
197+
# Contribute
198+
You can use this code as you like. If you find a bug, or want to ask for a feature, just open an issue, and we'll do our best. If you can fix it, do a pull request to dev branch, and we promise to review it as fast as possible to merge it.
199+
200+
If you are new on this open source world, here is a short guide about how to make a pull request to contribute:
201+
202+
1. Fork then clone `git clone git@github.com:your-username/modelate.git` **CodingCarlos/modelate** repository.
203+
2. Create a new branch in **your personal forked repo**, with a name similar to your edits, such as `fix-whatever`.
204+
3. Make your edits inside your new branch.
205+
4. Commit them and push them back to **your personal github fork**.
206+
5. Make a new Pull Request on the **CodingCarlos/modelate** repo. Point your branch to the `dev` `CodingCarlos/modelate`'s branch and submit.
207+
6. We will do my best to review and accept the code as soon as possible.

0 commit comments

Comments
 (0)