Contributing to forxr
Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.
Types of Contributions
Report Bugs
If you are reporting a bug, please first ensure if there is already an open issue for the same and add your suggestions to minimize redundancy. Otherwise, please include the following information when reporting a new bug:
- Your operating system name and version.
- Any details about your local setup that might be helpful in troubleshooting.
- Detailed steps to reproduce the bug.
Fix Bugs
Look through the GitHub issues for bugs. Anything tagged with “bug” and “help wanted” is open to whoever wants to implement it.
Implement Features
Look through the GitHub issues for features. Anything tagged with “enhancement” and “help wanted” is open to whoever wants to implement it.
Get Started!
Ready to contribute? Here’s how to set up forxpy
for local development.
Download a copy of
forxr
locally.-
Install
forxr
usingdevtools
:# install.packages("devtools") devtools::install_github("UBC-MDS/forxr")
-
Use
git
(or similar) to create a branch for local development and make your changes:$ git checkout -b name-of-your-bugfix-or-feature
When you’re done making changes, check that your changes conform to any code formatting requirements and pass any tests.
Commit your changes and open a pull request.
Pull Request Guidelines
Before you submit a pull request, check that it meets these guidelines:
- The pull request should include additional tests if appropriate.
- If the pull request adds functionality, the docs should be updated.
- The pull request should work for all currently supported operating systems and versions of R.