Skip to content

Latest commit

 

History

History
38 lines (27 loc) · 1.99 KB

CONTRIBUTING.md

File metadata and controls

38 lines (27 loc) · 1.99 KB

Contributing to 532-Group 12

Thank you for your interest in contribution to this project. We welcome all contributions and suggestions for improvement of this project!. For more info, please read below.

Report bugs

If you notice a bug or have a question or a request, please open up an issue here

Submit chnages

If you'd like to contribute a feature or bug fix, follow steps below.

  1. Fork this repository.
    You can fork our repo. It allows that you could edit any change in your own version of this project.
  2. Make change for bugs or improvement.
    Befor you make any changes, you should always file an issue and make sure someone from the team agrees that it's a problem.
  3. Submit a pull request.
    After make any changes, you could submit a pull request.(For the detailed pull request prcocess, please read below.)

Pull request process

  • We recommend that you create a Git branch for each pull request (PR).
  • New code should follow the tidyverse style guide. You can use the styler package to apply these styles, but please don't restyle code that has nothing to do with your PR.
  • We use roxygen2, with Markdown syntax, for documentation.
  • We use testthat. Contributions with test cases included are easier to accept.

Code of Conduct

Please note that this project is released with a code of conduct. By participating in this project you agree to abide by its terms.

Attribution

These contributing guidelines were adapted from the dplyr contributing guidelines.