Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
93 lines (69 loc) · 4.01 KB

CONTRIBUTING.md

File metadata and controls

93 lines (69 loc) · 4.01 KB

CONTRIBUTING

Welcome!

Welcome! We're glad you want to contribute to the ORB project! 💖

Table of Contents

Ways to Contribute

We welcome ideas, feedback, questions, and suggestions.

For comments about ORB code, data, or UI, please create an issue in the corresponding sub-project repository.

For comments about overall ORB governance, roadmap, or strategy, feel free to create an issue in this repository.

Review the data

If you are a member of the CURIOSS group, you can access the ORB data for your university! Just create an issue in any of the ORB repositories or email juanitagomezr2112@gmail.com, and we'll share it with you. We would love your feedback on the accuracy of the pipeline's predictions.

Review the UI

We hope to have the repoexplorer dashboard (a Shiny app) deployed on the web soon. In the meantime, CURIOSS members can download the data and deploy the app locally if they wish. Please let us know what you think of the existing features and what features you'd like to see next.

Review the code

Since this project is moving very quickly, we recommend starting with an issue rather than a PR. If the maintainers confirm that a PR is appropriate, then here are some suggestions to improve your PR (and its chances of being accepted):

  • Include a clear description of what the PR does and why.
  • Keep the PR focused on one "logical" update, not multiple unrelated updates.
  • Link to relevant issues using "Fixes #123" or "Addresses #456".
  • Use a formatter such as Prettier, even if you're just contributing text. (We will probably implement a formatting checker eventually.)
  • Use Conventional Commits where possible.
  • Consider using "draft" and "ready" status labels (click here for more information).

If you've never contributed to an upstream repository on GitHub, read this tutorial to learn the jargon and concepts. This tutorial is also a good step-by-step walkthrough.

Join our community

Anyone interested in this project or the OSPO is welcome to join our Slack Workspace and/or come to any of our coworking sessions. These are casual, drop-in-if-you-feel-like it sessions where you can:

  • Get help with a PR for this repo
  • Ask questions relating to OSS in general, your campus OSPO, or the OSPO network
  • Get help finding a project to work on, or getting more contributors for your own project
  • Or just have a dedicated time to work on your projects or to tackle those important-but-often-postponed admin tasks

You never need an invite to join us. In fact, we want you to join us, even if you don’t have anything you feel like you want to contribute. Just being there is enough! You don’t have to turn on your video. The first time you come, just introducing yourself is perfectly fine. Over time, we hope that you feel comfortable voicing your opinions, giving feedback on others’ ideas, and even sharing your own ideas, and experiences.

Contact us

We generally try to keep our conversations on GitHub, but if you prefer to use email, you can email ospo@ucsb.edu, juanitagomezr2112@gmail.com, or any of the folks listed here: https://ucospo.net/about/#contact-us

Code of Conduct

Please read and abide by our Code of Conduct.