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.
By participating in this project, you agree to abide by the code of
conduct.
Types of contributions
Don’t feel that you must be a computer whiz to make meaningful
contributions. Feel free to:
New to GitHub?
Getting ready to make your first contribution? Here are a couple of
tutorials you may wish to check out:
How to contribute code
- Fork the repository
- Clone the repository from GitHub to your computer e.g,.
git clone https://github.com/ropensci/nomisr.git
- Make sure to track progress upstream (i.e., on our version of
nomisr at ropensci/nomisr)
git remote add upstream https://github.com/ropensci/nomisr.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
- Submit a pull request to home base (likely master branch, but check
to make sure) at
ropensci/nomisr
- In general follow the convention of https://r-pkgs.had.co.nz/r.html#style (snake_case
functions and argument names, etc.)
- Where there is conflict, default to the style of
nomisr
- Use explicit package imports (i.e. package_name::package_function)
and avoid @import if at all possible