Skip to content

docs: add CONTRIBUTING.md guide for contributors#28

Merged
Daniel15568 merged 1 commit into
data-centt:mainfrom
rahulthakur3510:docs/add-contributing-guide
Jul 17, 2026
Merged

docs: add CONTRIBUTING.md guide for contributors#28
Daniel15568 merged 1 commit into
data-centt:mainfrom
rahulthakur3510:docs/add-contributing-guide

Conversation

@rahulthakur3510

Copy link
Copy Markdown

Description

This PR introduces a dedicated CONTRIBUTING.md file to help new contributors understand the project's guiding principles and workflow.

It extracts the existing contribution guidelines from the README.md and expands on them, explicitly highlighting:

  • The direct-to-output philosophy (avoiding unnecessary knobs and options).
  • The strict requirement to support Polars alongside pandas via the @_backend_aware decorator.
  • A step-by-step workflow starting with opening an issue for discussion before writing code.

Related Issues

Closes #24

Type of Change

  • Documentation Update

- Extract contribution guidelines from README
- Detail core principles and Polars requirement
- Provide step-by-step contribution workflow
Comment thread CONTRIBUTING.md

Percentify is built on the idea of simplicity and directness.

> Keep each method as direct-to-output as possible. A percentify function should return the single most common answer in one line, and point users to the underlying library (pandas, scipy, statsmodels, scikit-learn) for the full, configurable version when the simplest output isn't what they're after.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Looks good

@Daniel15568
Daniel15568 merged commit 39561ae into data-centt:main Jul 17, 2026
7 checks passed
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.

Create a contributing.md

2 participants