Skip to content

Contributors

Kalinda Pride edited this page Apr 25, 2021 · 3 revisions

So you're interested in contributing to LingView? Welcome! Please reach out to Scott (scott_anderbois@brown.edu) and/or Kalinda (kalinda.pride@gmail.com) so we can talk with you and give you a tour. In the interim, here's a wall of text that might be helpful, especially if you're interested in the computer programming side of things.

For background reading, I'd recommend skimming our academic paper (http://hdl.handle.net/10125/24916), and optionally the help articles on the wiki (https://github.com/BrownCLPS/LingView/wiki). You may also want to refer to the "Ultimate Guide", a usage manual for internal collaborators that covers more specifics of our setup. Ask Kalinda (kalinda.pride@gmail.com) or another project member for an updated copy.

The way the project is structured, we have a main GitHub repo at https://github.com/BrownCLPS/LingView, with a corresponding website at https://brownclps.github.io/LingView. This repo is what people should start from if they want to use LingView for their own corpus, and it's where new features and bug fixes are added.

Then, we have two language-specific repos: https://github.com/YucatecMaya/LingView, with a website at https://yucatecmaya.github.io/LingView, and https://github.com/Cofan-ALDP/LingView, with a website at https://cofan-aldp.github.io/LingView. The Cofan-ALDP website has audio and video, but you won't see audio or video files in the repo because those files are hosted on Brown's servers. When changes (features or bug fixes) are made to the BrownCLPS repo, we merge those changes into the Cofan-ALDP and YucatecMaya repos to keep them up to date.

If you'd like to dive in right away, start by installing LingView on your computer. Follow the instructions on the BrownCLPS wiki for installing LingView, except that you should clone the repo (if prompted, choose "for my own purposes") instead of downloading the zip file. Then you can take a look at the issues (https://github.com/BrownCLPS/LingView/issues) and start working on anything that catches your interest. If you get an error message at any point, there's a decent chance it's covered on the Troubleshooting page (https://github.com/BrownCLPS/LingView/wiki/Preprocessing-errors).

To get write access to the repositories, please send your GitHub username to Kalinda (kalinda.pride@gmail.com). Other project members might be able to give you access as well. While working on your own branch(es), anything goes; before making changes to the master branch, please test thoroughly and when in doubt, get Kalinda or another project member to review your code.