Merge pull request #3 from rq1995/master

Fix typo in CONTRIBUTING.md

CONTRIBUTING.md

@@ -1,37 +1,42 @@
 # Contributing
 
-Persons contributing to this project agree to the [code of conduct](./CONDUCT.md) and agree to the potential redistribution of their code under our license.
+Persons contributing to this project agree to the [code of conduct](./CODE_OF_CONDUCT.md) and agree to the potential redistribution of their code under our license.
 
 ## Contributor Agreement: 
 
 ### Task:
 - Ha @hadinh1306 : AIC + Table output
 - Simran @simrnsethi : BIC
-- Stephanie @rq1995 : Mallow’s 
+- Stephanie @rq1995 : Mallow’s Cp
 
 ### Communication:
+Each group member is responsible to be:
+
 - Responsive on Slack , especially during Friday and Saturday. 
 - 10-minute stand-up meeting on Monday during lunch break, to talk about weekly plan.
 
-### Other pull requests
-- We love pull requests from everyone.
-- Push to your fork and submit a pull request.
-- At this point you're waiting on us. We like to at least comment on pull requests within a week.
-- Write tests.
-- Write a good commit message.
+### Contribute to the project
+- For small changes, create Branch is ok. Please follow the tips about commit message below (In **How to contribute** part.)
+- For big changes, please use Folk. Please follow the tips about commit message below (In **How to contribute** part.).
+- Commit frequently with clear and concise commit message.
+- Write tests for function changes.
+- Once your changes are done, submit a Pull Request.
+- Wait for comments from team member. Then make changes from your Branch/Folk repo.
+- Only merge after reaching whole team agreement.
 
 ## Where to Contribute(Workflow)
 
 #### Using GitHub
 1.  We can use GitHub flow (branch) to manage changes:
-   - Create a new branch in your desktop copy of this repository for each significant change.
-   - Commit the change in that branch.
+   - Clone this repo. Create a new branch in your desktop copy of this repository for each significant change.
+   - Commit the change in that branch[(about branch)](https://help.github.com/articles/about-branches/).
    - Submit a pull request from that branch to the master repository.
    - If you receive feedback, make changes on your desktop and push to your branch on GitHub: the pull request will update automatically.
    - **If a major change is made by any person, tag other two. If this change is approved by all → accept pull request.**
 
 2.   We also use GitHub flow (fork) to manage changes:
-   - Fork, then clone this repo
+   - Fork [(How to fork)](https://help.github.com/articles/working-with-forks/)
+, then clone this repo. 
    - Push that branch to your fork of this repository on GitHub.
    - Submit a pull request
    - If you receive feedback, make changes on your desktop and push to your branch on GitHub: the pull request will update automatically.
@@ -46,30 +51,35 @@ Persons contributing to this project agree to the [code of conduct](./CONDUCT.md
 - Big changes:
 
 ```
-$ git commit -m "A brief summary of the commit
-> 
-> A paragraph describing what changed and its impact."
+ git commit -m "A brief summary of the commit
+
+ A paragraph describing what changed and its impact."
 ```
 
 -  Small changes:
    - 1-line detailed message including what change you made.
 
+ ```
+git commit -m "Concise summary of what you did here"
+```
+
 - Frequent commit everytime you make changes.
 
 
 #### Testing conventions
-- We will add details later.
+
+- Details coming in 1 week.
+
 
 #### Coding convention
 - Python:
 
       - All code should in `.py` file rather than jupyter notebook file
 - R:
-      - We avoid `=` when assign objects. We usually use `->`
-      - recommends that contributors use `%>%` which **dplyr** imports from **magrittr**.
-      - All code should in `.R` file rather than notebook file.
-
-
-
+      - Avoid using `=` when assign objects. Instead, use `->`
+      - Use `%>%` (including in **dplyr** package)
+      - All code should be in `.R` file rather than `.Rmd` or R notebook.
 
 
+## Attribution
+This document was adapted from [here](https://github.com/swcarpentry/r-novice-inflammation/blob/gh-pages/CONTRIBUTING.md).

bin/README.md

@@ -0,0 +1 @@
+Data directory for compiled binaries or scripts

data/README.md

@@ -0,0 +1 @@
+Data directory for storing fixed data sets

doc/README.md

@@ -0,0 +1 @@
+Doc directory include notebooks and manuscripts