Thanks for taking the time to contribute!
The following is a set of guidelines for contributing to TrenchR. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
What should I know before I get started? * TrenchR
How Can I Contribute? * Ready to develop * Reporting Bugs * Suggesting Enhancements * Your First Code Contribution * Pull Requests
Styleguides * Git Commit Messages * R Styleguide
Additional Notes * Issue and Pull Request Labels
As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities. We welcome and appreciate all contributions regardless of contributor identity or level of experience. We adhere to the Contributor Covenant (http:contributor-covenant.org).
TrenchR is an open source project — it's made up of over 10 modules. If you are considering contributing to TrenchR, this section should help you with that.
TrenchR is modular. The R scripts cover a particular category (aka modules), and each have multiple function definitions.
Here's a partial list of modules:
Utility functions - Miscellaneous utility functions including zenith angle, declination angle, and day of year.
Microclimate functions - Separated into multiple files.
Energy Budgets - Separated into multiple files.
This section guides you through submitting a bug report for TrenchR.
Bugs are tracked as GitHub issues.
Explain the problem and include additional details to help maintainers reproduce the problem:
Include details about your configuration and environment:
This section guides you through submitting an enhancement suggestion for TrenchR, including completely new features and minor improvements to existing functionality. Following these guidelines helps maintainers and the community understand your suggestion :pencil: and find related suggestions :mag_right:.
Enhancement suggestions are tracked as GitHub issues. Create an issue on TrenchR repository and provide the following information:
Unsure where to begin contributing to TrenchR? You can start by looking through these beginner
and help-wanted
issues:
beginner
issues.Both issue lists are sorted by total number of comments. While not perfect, number of comments is a reasonable proxy for impact a given change will have.
Additional project information is available on the TrEnCh Project website.
TrenchR packages can be developed locally. For instructions on how to do this, see the develop section
[ci skip]
in the commit title:art:
when improving the format/structure of the code:racehorse:
when improving performance:non-potable_water:
when plugging memory leaks:memo:
when writing docs:penguin:
when fixing something on Linux:apple:
when fixing something on macOS:checkered_flag:
when fixing something on Windows:bug:
when fixing a bug:fire:
when removing code or files:green_heart:
when fixing the CI build:white_check_mark:
when adding tests:lock:
when dealing with security:arrow_up:
when upgrading dependencies:arrow_down:
when downgrading dependencies:shirt:
when removing linter warningsAll R code style is borrowed from Hadley Wickham R Pkgs book R packages.
#' Converts angle in radians to degrees
#'
#' @details Converts angles in radians to degrees
#'
#' @description This function allows you to convert angle in radians to degrees
#' @param rad angle in radians
#' @keywords radians to degrees
#' @return angle in degrees
#' @export
#' @examples
#' \dontrun{
#' radian_to_degree(rad=0.831)
#' }
radian_to_degree <- function(rad) {(rad * 180) / (pi)}
This section lists the labels we use to help us track and manage issues and pull requests.
Contributrion template adapted by referring to Atom and rOpenSci projects.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.