Skip to content

Commit

Permalink
Merge pull request #211 from philerooski/phil-patch-206
Browse files Browse the repository at this point in the history
include information about getting help and filing issues
  • Loading branch information
philerooski authored Feb 26, 2020
2 parents 1990aba + 6208b50 commit af53706
Showing 1 changed file with 14 additions and 2 deletions.
16 changes: 14 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,8 +89,20 @@ At the moment, only accelerometer and gyroscope sensors have this powerful proce

For more information on how to augment mhealthtools with your own functionality — including not just your own feature extraction functions, but also your own preprocessing/data-cleaning steps — we highly recommend reading the vignettes.

### Contributing
To contribute, [fork](http://help.github.com/fork-a-repo/) the [main repo](https://github.com/Sage-Bionetworks/mHealthTools), branch off a [feature branch](https://www.google.com/search?q=git+feature+branches) from `develop`, [commit](http://git-scm.com/docs/git-commit) and [push](http://git-scm.com/docs/git-push) your changes to your fork and submit a [pull request](http://help.github.com/send-pull-requests/) for `Sage-Bionetworks/mhealthtools:develop`.
### Getting Help

If you have questions about using this package, there are a number of readily available resources. Vignettes are provided which demonstrate typical package use, how to extend the functionality of the provided functions, and feature definitions. Follow the installation instructions about installing the package with vignettes above and access the vignettes from within an R session:

```
browseVignettes("mhealthtools")
```

If you have questions about package usage that are not covered in the function docstrings or the vignettes, we encourage you to file an issue. If your question is not appropriate to be posted as a public issue, you may privately contact the package authors (`[aut]`) listed below.

### Contributing and Reporting Issues
To report an issue, please file a GitHub issue with the [main repo](https://github.com/Sage-Bionetworks/mHealthTools).

If you would like to contribute to mhealthtools, please file an issue so that we can establish a statement of need, avoid redundant work, and track progress on your contribution. Once an issue has been filed and we've identified how to best orient your contribution with package development as a whole, [fork](http://help.github.com/fork-a-repo/) the [main repo](https://github.com/Sage-Bionetworks/mHealthTools), branch off a [feature branch](https://www.google.com/search?q=git+feature+branches) from `develop`, [commit](http://git-scm.com/docs/git-commit) and [push](http://git-scm.com/docs/git-push) your changes to your fork and submit a [pull request](http://help.github.com/send-pull-requests/) for `Sage-Bionetworks/mhealthtools:develop`.

### Authors
* Phil Snyder <[email protected]> [aut, cre]
Expand Down

0 comments on commit af53706

Please sign in to comment.