Skip to content

Latest commit

 

History

History
40 lines (23 loc) · 2.94 KB

CONTRIBUTING.md

File metadata and controls

40 lines (23 loc) · 2.94 KB
Raw

Contributing to iconr

This outlines how to propose a change to iconr.

Fixing typos

You can fix typos, spelling mistakes, or grammatical errors in the documentation (.Rd files) directly using the GitHub web interface.

Bigger changes

To develop the versatility of the package, we encourage contributions directly related to:

  • Shape analysis: in incor 0.1.0, graphical units are considered for their centroid, a POINT. For the next releases of the package, we would like the possibility to deal with POLYGON geometries, in order to process the graphical units with shape analysis (Procrustes analysis, etc.).

  • Typology: we aim to create a hierarchical vocabulary (ie, structured vocabulary), in the form of a directed graph, to describe both graphical units typology and technology, mostly for Prehistoric and Protohistoric iconography (like this). To get this thesaurus shared between different users, we need it in in different languages, easily editable, etc.

  • Harris Matrix: incor 0.1.0 has a diachronic edge which is the first step to model overlaping/superimposition/relative chronology of the iconographical content. We want to go further, for example to recreate dynamically a Harrix Matrix for each graphical item.

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("zoometh/iconr", fork = TRUE).

  • 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.

Code of Conduct

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