CONTRIBUTING.md

In sebastiz/EndoMineR: Functions to mine endoscopic and associated pathology datasets

Contributing to EndoMineR

Thank you for any and all contributions! Following these guidelines will help streamline the process of contributing and make sure that we're all on the same page. While we ask that you read this guide and follow it to the best of your abilities, we welcome contributions from all, regardless of your level of experience.

Types of contributions

All contributions are welcome, even just a comment or a slap on the back to say well done. Examples of contributions include:

• Identify areas for future development (open an Issue)
• Identify issues/bugs ([open an Issue] (https://github.com/sebastiz/EndoMineR/issues))
• Write tutorials/vignettes (open a Pull Request to contribute to the ones here, or make your own elsewhere and send us a link)
• Add functionality (open a Pull Request)
• Fix bugs (open a Pull Request)

New to GitHub?

Getting ready to make your first contribution? Here are a couple of tutorials you may wish to check out:

• Tutorial for first-timers
• How to contribute (in-depth lessons)
• GitHub on setup
• GitHub on pull requests.)

How to contribute code

• Fork the repository
• Clone the repository from GitHub to your computer e.g,. git clone https://github.com/ropensci/EndoMineR.git
• Make sure to track progress upstream (i.e., on our version of EndoMineR at ropensci/EndoMineR)
• git remote add upstream https://github.com/ropensci/EndoMineR.git
• Before making changes make sure to pull changes in from upstream with git pull upstream
• Make your changes
• For changes beyond minor typos, add an item to NEWS.md describing the changes and add yourself to the DESCRIPTION file as a contributor
• Push to your GitHub account

Code formatting

• In general follow the convention of http://r-pkgs.had.co.nz/r.html#style (snake_case functions and argument names, etc.)
• Where there is conflict, default to the style of EndoMineR
• Use explicit package imports (i.e. package_name::package_function) and avoid @import if at all possible

sebastiz/EndoMineR documentation built on Dec. 4, 2022, 7:04 p.m.