Skip to content

Latest commit

 

History

History
50 lines (27 loc) · 2.58 KB

CONTRIBUTING.md

File metadata and controls

50 lines (27 loc) · 2.58 KB

Contributing to crseEventStudy

Thanks for taking the time to contribute!

The following is a set of guidelines for contributing to the crseEventStudy R-package, which is hosted on CRAN. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

Code of Conduct

This project and everyone participating in it is governed by the crseEventStudy Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to siegfried.koestlmeier@gmail.com.

How Can I Contribute?

Reporting Bugs

This section guides you through submitting a bug report for crseEventStudy. Following these guidelines helps to understand your report, reproduce the behavior, and find related reports.

When you are creating a bug report, please include as many details as possible and provide information about your system and R version. Fill out the required template, the information it asks for helps to resolve issues faster.

Note: If you miss a feature, please fill out the feature request rather than a bug report.

Suggesting Enhancements

Feel free to submit an enhancement suggestion for crseEventStudy, including completely new features and minor improvements to existing functionality. Please describe the desired functionality in detail and provide a source to an academic paper if the feature is based on statistical methods.

Just fill in the feature request, including the steps that you imagine you would take if the feature you're requesting existed.

Pull Requests

Styleguides

Git Commit Messages

  • Use the present tense
  • Use the imperative mood
  • Limit the first line to 72 characters or less

R Styleguide

All R code must adhere to Google's R Style Guide.

CRAN Policy

When contributing to crseEventStudy, any changes must be conform with the CRAN-Policy. Please check all contributing code with R CMD check --as-cran before commiting to GitHub - no errors or warnings may occur.