The goal of this guide is to help you get up and contributing to PoPS Core and/or rPoPS as quickly as possible. The guide is divided into two main pieces:

1. Filing a bug report or feature request in an issue.

1. Suggesting a change via a pull request.

Please note that PoPS Core and rPoPS are released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.

Issues

When filing an issue, the most important thing is to include a minimal reproducible example so that we can quickly verify the problem, and then figure out how to fix it. There are three things you need to include to make your example reproducible: required packages, data, code.

1. The easiest way to include data is to include a link to a google drive folder containing your rasters and

1. Spend a little bit of time ensuring that your code is easy for others to read:
   • make sure you've used spaces and your variable names are concise, but informative
   • use comments to indicate where your problem lies
   • do your best to remove everything that is not related to the problem.
     The shorter your code is, the easier it is to understand.

Pull

To contribute a change to PoPS Core or rPoPS, follow these steps:

1. Create a branch in git and make your changes.

1. Push branch to github and issue pull request (PR) if new feature add to a feature/new_feature branch.

1. Discuss the pull request.

1. Iterate until either we accept the PR or decide that it's not a good fit for this project.

Each of these steps are described in more detail below. This might feel overwhelming the first time you get set up, but it gets easier with practice.