Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add project planning voting boxplot generation script #3364

Merged
merged 5 commits into from
Nov 21, 2023

Conversation

AetherUnbound
Copy link
Collaborator

@AetherUnbound AetherUnbound commented Nov 16, 2023

Description

No issue for this.

This PR adds a script which can be used to create the effort/impact boxplots for yearly project planning. Instructions for how the input spreadsheet should be constructed are defined within the new directories.

An example output from the script is also included. If folks have any comments or suggestions for improvements of the graph itself, please feel free to add them!

image

Testing Instructions

Due to the nature of the voting, this presently can only be tested by Openverse maintainers.

  1. Run pipenv install in the new directory
  2. Download the voting spreadsheet (access restricted) as a ".xlsx" file (default location is data/votes.xlsx within the project_planning directory).
  3. Run pipenv run python graph_project_voting.py and verify the files were generated in outputs/

Checklist

  • My pull request has a descriptive title (not a vague title likeUpdate index.md).
  • My pull request targets the default branch of the repository (main) or a parent feature branch.
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • I added or updated tests for the changes I made (if applicable).
  • I added or updated documentation (if applicable).
  • I tried running the project locally and verified that there are no visible errors.
  • I ran the DAG documentation generator (if applicable).

Developer Certificate of Origin

Developer Certificate of Origin
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

@AetherUnbound AetherUnbound requested a review from a team as a code owner November 16, 2023 01:02
@AetherUnbound AetherUnbound added the 🟨 priority: medium Not blocking but should be addressed soon label Nov 16, 2023
@AetherUnbound AetherUnbound added the 🌟 goal: addition Addition of new feature label Nov 16, 2023
@AetherUnbound AetherUnbound requested a review from obulat November 16, 2023 01:02
@AetherUnbound AetherUnbound added 🤖 aspect: dx Concerns developers' experience with the codebase 🧱 stack: mgmt Related to repo management and automations labels Nov 16, 2023
@github-actions github-actions bot added 🏷 status: label work required Needs proper labelling before it can be worked on 🚦 status: awaiting triage Has not been triaged & therefore, not ready for work labels Nov 16, 2023
@obulat obulat removed the request for review from fcoveram November 16, 2023 08:21
@obulat obulat removed 🏷 status: label work required Needs proper labelling before it can be worked on 🚦 status: awaiting triage Has not been triaged & therefore, not ready for work labels Nov 17, 2023
Copy link
Contributor

@obulat obulat left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice! Tested locally and it works well.

@obulat obulat requested review from dhruvkb and krysal November 21, 2023 08:07
Copy link
Member

@dhruvkb dhruvkb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, the contents of the README.md could also be a page in the docs but this is okay for small independent utils that are not directly a part of the Openverse project.

@AetherUnbound
Copy link
Collaborator Author

LGTM, the contents of the README.md could also be a page in the docs but this is okay for small independent utils that are not directly a part of the Openverse project.

That's....a really good idea 😮 🤔 I'll definitely think about moving all our project planning stuff into the public docs once the process for this year is over! It could be helpful to other groups!

@AetherUnbound AetherUnbound merged commit 2d2e50e into main Nov 21, 2023
@AetherUnbound AetherUnbound deleted the feature/voting-box-plot-generation branch November 21, 2023 19:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🤖 aspect: dx Concerns developers' experience with the codebase 🌟 goal: addition Addition of new feature 🟨 priority: medium Not blocking but should be addressed soon 🧱 stack: mgmt Related to repo management and automations
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

3 participants