Skip to contents

Contributing to sentimentanalyzerR

This outlines how to propose a change to sentimentanalyzerR. For more detailed info about contributing to this, and other tidyverse packages, please see the development contributing guide.

Core Team Contribution

All core team members should work on their feature branch. All contributions are expected to go through code review via a pull request (PR). A branch protection rule is set in the main branch (currently at least 1 reviewer is required). There shouldn’t exist commits in the main branch, except the ones created when the team merged branches.

Team members should review the changes and approve the PR within 7 days.

Team members should git pull to get the latest version of the project before making changes.

General contribution steps:

  1. git pull to obtain the latest changes from the remote repository
  2. git switch -c , where branch_name is the name of the new feature branch
  3. Modify code & test the code
  4. git add , add all the modified files
  5. git commit -m “msg”, commit changes with a meaningful commit message
  6. git push –set-upstream origin , pushing local changes with a new branch to the remote
  7. Submit a PR
  8. Other teammates should review the PR within 7 days, and approve the PR or add comments if necessary
  9. Merge branch

Fixing typos

You can fix typos, spelling mistakes, or grammatical errors in the documentation directly using the GitHub web interface, as long as the changes are made in the source file. This generally means you’ll need to edit roxygen2 comments in an .R, not a .Rd file. You can find the .R file that generates the .Rd by reading the comment in the first line.

Bigger changes

If you want to make a bigger change, it’s a good idea to first file an issue and make sure someone from the team agrees that it’s needed. If you’ve found a bug, please file an issue that illustrates the bug with a minimal reprex (this will also help you write a unit test, if needed).

Pull request process

  • Fork the package and clone onto your computer. If you haven’t done this before, we recommend using usethis::create_from_github("UBC-MDS/sentimentanalyzerR", fork = TRUE).

  • Install all development dependencies with devtools::install_dev_deps(), and then make sure the package passes R CMD check by running devtools::check(). If R CMD check doesn’t pass cleanly, it’s a good idea to ask for help before continuing.

  • Create a Git branch for your pull request (PR). We recommend using usethis::pr_init("brief-description-of-change").

  • Make your changes, commit to git, and then create a PR by running usethis::pr_push(), and following the prompts in your browser. The title of your PR should briefly describe the change. The body of your PR should contain Fixes #issue-number.

  • For user-facing changes, add a bullet to the top of NEWS.md (i.e. just below the first header). Follow the style described in https://style.tidyverse.org/news.html.

Code style

  • New code should follow the tidyverse style guide. You can use the styler package to apply these styles, but please don’t restyle code that has nothing to do with your PR.

  • We use roxygen2, with Markdown syntax, for documentation.

  • We use testthat for unit tests. Contributions with test cases included are easier to accept.

Code of Conduct

Please note that the sentimentanalyzerR project is released with a Contributor Code of Conduct. By contributing to this project you agree to abide by its terms.