- All contributions to DataSHIELD packages should be managed through GitHub using issues, branches, and pull requests (merge requests).
- The recommended workflow is:
- Open or identify an issue (see issue template [here]) (contributer)
- Agree with maintainers on the requirements (contributer)
- Fork the repository (if external contributor)
- Pull the latest changes from the main repository (contributer)
- Create a dedicated branch for the issue (contributer)
- Implement and test the changes (contributer)
- Open a pull request linked to the issue , use issue number in the body and tag the maintainer (contributer)
- Review and merge the pull request (maintainer)
- Delete the branch after merging (maintainer)
- Each package repository should include a: CONTRIBUTING.md file defining the contribution guidelines for the package.
use_tidy_contributing() function from the usethis package, for generating template of the CONTRIBUTING.md. Please modify the file to include the sections described [here].
- Include an issue template to help users fill better bug reports or feature requests. You could use this template or include a modified version.
- Consider adding contributors in DESCRIPTION, as contributor (“ctb”) for small contributions, author (“aut”) for bigger contributions.
- At a minimum consider adding the name of contributors near the feature/bug fix line in NEWS.md.