diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..7a95bdc --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,56 @@ +name: Bug report +description: Report a reproducible problem in code, packaging, docs, or workflows. +title: "[Bug]: " +labels: + - bug +body: + - type: markdown + attributes: + value: | + Please include enough detail for someone else to reproduce the problem. + - type: textarea + id: summary + attributes: + label: Summary + description: What went wrong? + placeholder: A concise description of the bug. + validations: + required: true + - type: textarea + id: reproduction + attributes: + label: Reproduction + description: Provide exact steps, commands, or code to reproduce the issue. + placeholder: | + 1. ... + 2. ... + 3. ... + validations: + required: true + - type: textarea + id: expected + attributes: + label: Expected behavior + placeholder: What did you expect to happen? + validations: + required: true + - type: textarea + id: environment + attributes: + label: Environment + description: Include OS, Python version, PyTorch version, CUDA version, and install method if relevant. + placeholder: | + - OS: + - Python: + - PyTorch: + - CUDA: + - Install method: + validations: + required: false + - type: textarea + id: logs + attributes: + label: Logs or screenshots + description: Paste traceback, logs, or screenshots if relevant. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..78980c0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: true +contact_links: + - name: Security report + url: mailto:ymjiii98@gmail.com + about: Report security vulnerabilities privately by email instead of opening a public issue. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..99d9d15 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,34 @@ +name: Feature request +description: Suggest an improvement to the library, docs, benchmarks, or workflows. +title: "[Feature]: " +labels: + - enhancement +body: + - type: textarea + id: problem + attributes: + label: Problem or motivation + description: What user need, workflow pain point, or limitation does this address? + validations: + required: true + - type: textarea + id: proposal + attributes: + label: Proposed change + description: Describe the feature, API, workflow, or docs improvement you want. + validations: + required: true + - type: textarea + id: alternatives + attributes: + label: Alternatives considered + description: Optional. Describe workarounds or alternative approaches. + validations: + required: false + - type: textarea + id: context + attributes: + label: Additional context + description: Benchmarks, references, links, or example usage. + validations: + required: false diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..0b50a89 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,15 @@ +## Summary + +- what changed +- why it changed + +## Validation + +- [ ] tests passed locally +- [ ] docs/build checks passed locally when relevant +- [ ] CI is expected to pass + +## Notes + +- affected areas: +- follow-up work, if any: diff --git a/.github/workflows/retire_repo_pages.yml b/.github/workflows/retire_repo_pages.yml deleted file mode 100644 index 19bc5bc..0000000 --- a/.github/workflows/retire_repo_pages.yml +++ /dev/null @@ -1,40 +0,0 @@ -name: Retire Repo Pages - -on: - push: - branches: [main] - paths: - - ".github/workflows/retire_repo_pages.yml" - - "deprecated_pages/**" - workflow_dispatch: - -permissions: - contents: read - pages: write - id-token: write - -concurrency: - group: retire-repo-pages - cancel-in-progress: true - -jobs: - deploy: - runs-on: ubuntu-latest - environment: - name: github-pages - url: ${{ steps.deployment.outputs.page_url }} - steps: - - name: Checkout - uses: actions/checkout@v4 - - - name: Configure Pages - uses: actions/configure-pages@v5 - - - name: Upload retirement site - uses: actions/upload-pages-artifact@v3 - with: - path: deprecated_pages - - - name: Deploy retirement site - id: deployment - uses: actions/deploy-pages@v4 diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..278be5e --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,53 @@ +# Code of Conduct + +## Our Pledge + +We want INFTY to be an open, constructive, and respectful project for everyone involved in its development and use. + +Contributors, maintainers, and community members are expected to participate in a way that supports a welcoming environment for people of different backgrounds, identities, experience levels, and perspectives. + +## Expected Behavior + +Examples of behavior that contribute to a positive environment include: + +- being respectful in technical discussions +- giving and receiving feedback in good faith +- focusing on the issue, code, or design rather than the person +- showing empathy and patience when others ask questions or make mistakes +- using clear and professional language in issues, pull requests, and review comments + +## Unacceptable Behavior + +Examples of unacceptable behavior include: + +- harassment, intimidation, or personal attacks +- discriminatory or derogatory language +- trolling, baiting, or deliberately inflammatory behavior +- publishing private information without permission +- sustained disruptive behavior in issues, pull requests, or other public channels + +## Scope + +This Code of Conduct applies in all project spaces, including: + +- GitHub issues +- pull requests and code review +- repository discussions and related public communication + +## Reporting + +If you experience or observe behavior that violates this Code of Conduct, please report it privately to: + +- `ymjiii98@gmail.com` + +Please include relevant context, links, screenshots, or other details if available. + +## Enforcement + +Project maintainers may remove, edit, or reject comments, commits, code, issues, or other contributions that violate this Code of Conduct. + +Maintainers may also temporarily or permanently restrict participation for repeated or severe violations. + +## Attribution + +This document is a lightweight project-specific adaptation inspired by common open source community conduct guidelines, including Contributor Covenant. diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000..e76ccaf --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,32 @@ +# Security Policy + +## Reporting a vulnerability + +If you believe you have found a security vulnerability in INFTY, please do not open a public GitHub issue. + +Instead, report it privately to: + +- `ymjiii98@gmail.com` + +Please include the following when possible: + +- a clear description of the issue +- the affected component or file path +- reproduction steps or a proof of concept +- the potential impact +- any suggested remediation + +We will review reports as time permits and aim to acknowledge valid reports promptly. + +## Scope + +This project is primarily a research and engineering toolkit. Security reports are still welcome, especially for: + +- package installation or release artifacts +- workflow or secret-handling issues +- unsafe file handling or code execution paths +- dependency-related exposure in supported usage paths + +## Disclosure + +Please allow reasonable time for investigation and remediation before public disclosure. diff --git a/theme_overrides/main.html b/theme_overrides/main.html index 3f1097f..19e5098 100644 --- a/theme_overrides/main.html +++ b/theme_overrides/main.html @@ -13,3 +13,26 @@ {{ browser_title }} {% endif %} {% endblock %} + +{% block extrahead %} + {{ super() }} + {% if config.repo_url %} + + {% endif %} +{% endblock %}