Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

[Meta] Ways to Contribute

Đang mở
  • Có gì không ổn?
#39 14 bình luận 1 reaction 1 người được giao Xem trên GitHub

@TimidRobot đang làm issue này rồi.

Từ ngày 3/3/2023.

Đánh giá

Issue này chưa được đánh giá.

Mô tả

✨ goal: improvement 🌟 goal: addition 🏷 status: label work required 💬 talk: discussion 💻 aspect: code 🤖 aspect: dx good first issue help wanted 🟨 priority: medium

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.

First

Ways to Contribute

  • Pull Requests (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
    • 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 #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. #2)

Tips

Conventions and best practices
Plot process data

Any plots in phase 3-report should graph data without significantly modifying it. This means that development of phase 2-process and phase 3-report usually needs to be done at the same time.

Put another way, there should be a 1:1 relationship between phase 3-report plots and phase 2-process CSV files.

Ngôn ngữ chính
Python
Star
48
Fork
74
Không có pull request nào được merge trong 30 ngày

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của creativecommons/quantifying

Tất cả issue của creativecommons/quantifying

Issue tương tự

Thêm issue về Python

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.