Skip to content
This repository
Browse code

[docs] Adds contributing.md

  • Loading branch information...
commit da50f6beac0af228590b7887a5205c67927a53a2 1 parent f9690bc
Nuno Job authored October 10, 2012

Showing 2 changed files with 20 additions and 21 deletions. Show diff stats Hide diff stats

  1. 20  CONTRIBUTING.md
  2. 21  README.md
20  CONTRIBUTING.md
Source Rendered
... ...
@@ -0,0 +1,20 @@
  1
+everyone is welcome to contribute with patches, bug-fixes and new features
  2
+
  3
+1. create an [issue][2] on github so the community can comment on your idea
  4
+2. fork `nano` in github
  5
+3. create a new branch `git checkout -b my_branch`
  6
+4. create tests for the changes you made
  7
+5. make sure you pass both existing and newly inserted tests
  8
+6. commit your changes
  9
+7. push to your branch `git push origin my_branch`
  10
+8. create a pull request
  11
+
  12
+to run tests make sure you npm test but also run tests without mocks:
  13
+
  14
+``` sh
  15
+npm run nock_off
  16
+```
  17
+
  18
+check this [blogpost](http://writings.nunojob.com/2012/05/Mock-HTTP-Integration-Testing-in-Node.js-using-Nock-and-Specify.html) to learn more about how to write your own tests
  19
+
  20
+[2]: http://github.com/dscape/nano/issues
21  README.md
Source Rendered
@@ -603,27 +603,6 @@ nano_env=testing node tests/doc/list.js list_doc_params
603 603
 
604 604
 where `list_doc_params` is the test name.
605 605
 
606  
-## contribute
607  
-
608  
-everyone is welcome to contribute with patches, bug-fixes and new features
609  
-
610  
-1. create an [issue][2] on github so the community can comment on your idea
611  
-2. fork `nano` in github
612  
-3. create a new branch `git checkout -b my_branch`
613  
-4. create tests for the changes you made
614  
-5. make sure you pass both existing and newly inserted tests
615  
-6. commit your changes
616  
-7. push to your branch `git push origin my_branch`
617  
-8. create a pull request
618  
-
619  
-to run tests make sure you npm test but also run tests without mocks:
620  
-
621  
-``` sh
622  
-npm run nock_off
623  
-```
624  
-
625  
-check this [blogpost](http://writings.nunojob.com/2012/05/Mock-HTTP-Integration-Testing-in-Node.js-using-Nock-and-Specify.html) to learn more about how to write your own tests.
626  
-
627 606
 ## meta
628 607
 
629 608
                     _

0 notes on commit da50f6b

Please sign in to comment.
Something went wrong with that request. Please try again.