Home

Welcome to the spict wiki!

Contributing code - implementing new features

Contributing code to spict is best done using Pull Requests (PR). We should start with a new branch based on a target branch (usually master or dev branch).

Here is a potential work flow:

1. Make new branch based on the target branch

git checkout -b name_describing_change

2. Make the additions needed
3. Increase the minor version in make_description.R
4. Build and install the package. This updates the description file first.

make install

5. Test the package locally

make testmore

6. Fix and commit everything. Remember to add new files. Use short but descriptive commit messages. If there is an github issue that you are fixing/addressing you can refer to it by it's id number in the commit message. When the PR is merged to the master branch it will automatically close all mentioned issues and make a reference to the PR.

git add .

git commit -am 'Add feature X. Fix bug in function y. Closes #99'

7. Push to the remote

git push origin name_describing_change

8. Make Pull Request. You can assign someone to review the pull request. It is a good idea to briefly describe the changes in the comment, maybe also including some code illustrating the new feature.

NEWS file

With every version change the NEWS file should be updated. The changes should be added in the top of the file.

Updating the vignettes

Use make vignette.

Writing testmore tests

todo