[Meta] Ways to Contribute

[TimidRobot]

Overview

⚠️ This meta-issue should not be worked on itself. Instead it is a place for me (@TimidRobot) to document ways to engage with this project.

Ways to Contribute

• Pull Requests (PRs)
  • Contribute a PR for an existing issue per Contribution Guidelines — Creative Commons Open Source
  • Help review PRs
• Issues
  • Create a new issue recommending a data source that should be included. Include information like:
    • quantity of records
    • types of metadata available
    • API documentation link
    • API requirements and limitations
    • (Also see sources.md)
  • Create a new issue related to a single script or data source:
    • Scripts should be using .env (theskumar/python-dotenv) and not query_secrets.py or similar
    • Scripts mustn't be monolithic--they should be limited to a single phase (ex. query, process, report. See [Feature] Automate Data Gathering and Analysis/Rendering #22)
    • Scripts must be designed to be run from the repository root via pipenv (ex. pipenv run PATH/SCRIPT.PY)
      • Script should determine its own path and set appropriate global variables (ex. DIR_ROOT, DIR_SCRIPT)
    • Scripts have a lot of duplication between them. Begin a shared library (remember to keep issues as small and descrete as possible--limit each issue/PR to a single script or data source).
    • Scripts should be using retries with exponential backoff (ex. [Feature] Use requests included exponential backoff #2)

[sumanbalayar08]

@TimidRobot, I'm interested in contributing to this project. Could you please provide more details on #39 or guide me on how to get started? Thanks!

[TimidRobot]

Please see Contribution Guidelines — Creative Commons Open Source for how we manage issues and PRs (we generally don't assign issues prior to resolution, and this issue is [Meta] and will not be assigned).

[akshansh-modi]

hey i wish to contribute to this repo but don't see any open issues that I can work on

[TimidRobot]

@akshansh-modi this project is currently in flux as it is reorganized as part of GSoC. It should be easier to contribute after 2024 Summer.