CONTRIBUTING.md

In XiaoyuLiang/i2d: Convert image to digital data

Contributing

Thanks for considering contributing our i2d package. When contributing to this repository, please first discuss the change you wish to make via Issues, email ([e-mail]), or any other method with the owners of this repository before making a change.

Report a bug

Before reporting a bug, please ensure the bug was not already reported by searching on GitHub under issues.

• Your operating system name and version (e.g. Windows 10 10.0, Mac OS 10.15.6).
• Detailed steps to reproduce the bug.
• Any details about your local setup that might be helpful in troubleshooting.

Propose an idea

Have an idea for a new i2d feature? Take a look at the package main page and issues to see if it is included or suggested. If not yet, suggest your idea as an issue on i2d. While we can't promise to implement your idea, it helps to:

• Explain in detail how it would work.
• Keep the scope as narrow as possible.
• Give an example of possible.

Improve the package documentation

Function documentation

Functions are described as comments near their code. If you want to improve a function description or make any change of the function, we recommend you to upload a new function with a new name.

1. Go to R/ directory in the code repository.
2. Upload the function documentation.

Development guidelines

We try to follow the GitHub flow for development.

1. Fork this repo and clone it to your computer. To learn more about this process, see this guide.
2. If you have forked and cloned the project before and it has been a while since you worked on it, pull changes from the original repo to your clone by using git pull upstream master.
3. Open the RStudio project file (.Rproj).
4. Make your changes:
   • Write and test your code.
   • Document your code.
   • Check your code with devtools::check() and aim for 0 errors and warnings.
5. Commit and push your changes.
6. Submit a pull request.

XiaoyuLiang/i2d documentation built on Oct. 20, 2020, 11:05 p.m.