adding issue templates

ievobio · Jan 31, 2019 · 179ff72 · 179ff72
1 parent 4549120
commit 179ff72
Show file tree

Hide file tree

Showing 3 changed files with 104 additions and 0 deletions.
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
@@ -0,0 +1,56 @@
+# CONTRIBUTING #
+
+### Fixing typos
+
+Small typos or grammatical errors in documentation may be edited directly using
+the GitHub web interface, so long as the changes are made in the _source_ file.
+
+*  YES: you edit a roxygen comment in a `.R` file below `R/`.
+*  NO: you edit an `.Rd` file below `man/`.
+
+### Prerequisites
+
+Before you make a substantial pull request, you should always file an issue and
+make sure someone from the team agrees that it’s a problem. If you’ve found a
+bug, create an associated issue and illustrate the bug with a minimal 
+[reprex](https://www.tidyverse.org/help/#reprex).
+
+### Pull request process
+
+*  We recommend that you create a Git branch for each pull request (PR).  
+*  Look at the Travis build status before and after making changes.
+The `README` should contain badges for any continuous integration services used
+by the package.  
+*  We recommend the tidyverse [style guide](http://style.tidyverse.org).
+You can use the [styler](https://CRAN.R-project.org/package=styler) package to
+apply these styles, but please don't restyle code that has nothing to do with 
+your PR.  
+*  We use [roxygen2](https://cran.r-project.org/package=roxygen2).  
+*  We use [testthat](https://cran.r-project.org/package=testthat). Contributions
+with test cases included are easier to accept.  
+*  For user-facing changes, add a bullet to the top of `NEWS.md` below the
+current development version header describing the changes made followed by your
+GitHub username, and links to relevant issue(s)/PR(s).
+
+### Code of Conduct
+
+Please note that the {{{ package }}} project is released with a
+[Contributor Code of Conduct](CODE_OF_CONDUCT.md). By contributing to this
+project you agree to abide by its terms.
+
+### See rOpenSci [contributing guide](https://ropensci.github.io/dev_guide/contributingguide.html)
+for further details.
+
+### Discussion forum
+
+Check out our [discussion forum](https://discuss.ropensci.org) if you think your issue requires a longer form discussion.
+
+### Prefer to Email? 
+
+Email the person listed as maintainer in the `DESCRIPTION` file of this repo.
+
+Though note that private discussions over email don't help others - of course email is totally warranted if it's a sensitive problem of any kind.
+
+### Thanks for contributing!
+
+This contributing guide is adapted from the tidyverse contributing guide available at https://raw.githubusercontent.com/r-lib/usethis/master/inst/templates/tidy-contributing.md 
diff --git a/.github/issue_template.txt b/.github/issue_template.txt
@@ -0,0 +1,28 @@
+**If you are submitting a piece of software for the Software Bazaar during the poster session,**
+June 23, please open an issue with the following information:
+
+- Issue Title: The name of the software
+- Issue Body:
+	- Who will be present at the Software Bazaar?
+	- Brief description of what the software does. What biological analyses does it perform?
+	Is it platform-specific? 
+
+If you intend to present software in the Software Bazaar, please file an issue containing
+this information by June 18.
+
+
+**If you are submitting a talk for the education lightning talks** during the afternoon session
+Wednesday June 26, please open an issue with the following information:
+
+- Issue Title: Name of Presenter
+- Issue Body: 
+	- What type of class are you teaching (i.e., Data science for biologists, Advanced programming
+	in R, Bioinformatics)? 
+	- What type of institution (i.e. PUI, R1, SLAC)? 
+	- What type of learners do you have (i.e., upper division undergrads, grads, freshmen)?
+	- How are you serving the course (i.e., R Studio server, local installs on participant computers)?
+
+The above information may be used to group talks in the presentation order. A member of the iEvoBio
+organizing committee will be in touch about how to submit your talk. 
+
+All contributions are expected to follow the [Code of Conduct](https://github.com/iEvoBio2019/2019-iEvoBio/blob/master/Conduct.md).
diff --git a/.github/pull_request_template.txt b/.github/pull_request_template.txt
@@ -0,0 +1,20 @@
+<!-- IF THIS INVOLVES AUTHENTICATION: DO NOT SHARE YOUR USERNAME/PASSWORD, OR API KEYS/TOKENS IN THIS ISSUE - MOST LIKELY THE MAINTAINER WILL HAVE THEIR OWN EQUIVALENT KEY -->
+
+<!-- If you've updated a file in the man-roxygen directory, make sure to update the man/ files by running devtools::document() or similar as .Rd files should be affected by your change -->
+
+<!--- Provide a general summary of your changes in the Title above -->
+
+## Description
+<!--- Describe your changes in detail -->
+
+## Related Issue
+<!--- if this closes an issue make sure include e.g., "fix #4"
+or similar - or if just relates to an issue make sure to mention
+it like "#4" -->
+
+## Example
+<!--- if introducing a new feature or changing behavior of existing
+methods/functions, include an example if possible to do in brief form -->
+
+<!--- Did you remember to include tests? Unless you're just changing
+grammar, please include new tests for your change -->