Skip to content

docs: add contributing guide and issue forms - #134

Open
yjouini wants to merge 5 commits into
mainfrom
docs/contributing-issue-templates
Open

yjouini wants to merge 5 commits into
mainfrom
docs/contributing-issue-templates

Conversation

@yjouini

@yjouini yjouini commented Aug 26, 2026

Copy link
Copy Markdown
Contributor

Closes #128

Summary

  • Add a concise, public-facing CONTRIBUTING.md covering issue routing, the fork-and-PR workflow, validation guidance, and pull request expectations.
  • Add GitHub issue forms for bug reports, feature proposals, and usage questions.
  • Keep logs and transcript excerpts optional, scoped, and explicitly sanitized.
  • Update the README to point contributors to the new guide.

Validation

  • uv sync --locked
  • uv run pre-commit run --all-files --show-diff-on-failure
  • uv run pytest (235 passed)
  • uv build

yjouini and others added 2 commits August 26, 2026 15:29
Add CONTRIBUTING.md as a routing document: where bugs, proposals, and
usage questions belong, how to propose a skill or tool change, the
Conventional Commits requirement enforced by the commit-msg hook and
pr-title.yml, and the verification gates. It references AGENTS.md,
CODING_STANDARDS_AND_STRUCTURE.md, and RELEASE.md rather than restating
them.

Add .github/ISSUE_TEMPLATE/ issue forms. The bug form requires the
harness transcript, host, plugin version, and instance DSS version, which
maintainers currently request by hand on every report. The feature form
requires the area and why existing tool and Cobuild paths do not cover
the request. config.yml disables blank issues and routes usage questions
to Slack.

Refs #128

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@yjouini
yjouini marked this pull request as ready for review August 27, 2026 11:27
@yjouini
yjouini requested a review from hanneshapke August 27, 2026 17:03

@hanneshapke hanneshapke left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

@yjouini please see my comment

blank_issues_enabled: false
contact_links:
- name: Contributing guide
url: https://github.com/dataiku/dataiku-headless/blob/main/CONTRIBUTING.md

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

url returns 404

Comment thread CONTRIBUTING.md

## Opening a pull request

1. Fork the repository and create a focused branch from `main`.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

@pmasiphelps @yjouini I am seeing a number of projects to prevent AI slop, including setting a max line limit for PRs. Any change above the limit needs an RFC first. At vLLM, the limit is 500 lines of code changes.

I like the guardrail against massie changes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: add contribution guidance and issue templates

2 participants