-
Notifications
You must be signed in to change notification settings - Fork 53
docs: add CONTRIBUTING.md guide for contributors #28
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Daniel15568
merged 1 commit into
data-centt:main
from
rahulthakur3510:docs/add-contributing-guide
Jul 17, 2026
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| # Contributing to Percentify | ||
|
|
||
| Thank you for your interest in contributing to Percentify! We welcome contributions, but ask that you follow the project's guiding principles to keep the library focused and simple. | ||
|
|
||
| ## Guiding Principles | ||
|
|
||
| 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. | ||
|
|
||
| - **No unnecessary knobs and options**: Anything that adds parameters for their own sake, or duplicates what the parent libraries already do well, is out of scope. For those cases, users should be pointed to the source library instead. | ||
| - **Keep it compact**: We try to keep the API surface compact on purpose. Please discuss big new features in an issue before writing code. | ||
|
|
||
| ## Technical Requirements | ||
|
|
||
| **It must support Polars.** | ||
| Every function in Percentify accepts both pandas and Polars objects (via the `@_backend_aware` decorator) and returns the same kind. Any new contribution must maintain this parity. You should not require the user to manually convert between backends or pass specific flags. | ||
|
|
||
| ## Contribution Workflow | ||
|
|
||
| If your idea keeps things simple, direct, and adheres to the principles above, here is how you can contribute: | ||
|
|
||
| 1. **Discuss first**: Open an issue to discuss your proposed change or feature. This saves time and ensures your contribution aligns with the project's goals. | ||
| 2. **Fork and Branch**: Fork the repository and create a new branch for your feature or bugfix. | ||
| 3. **Develop**: Write your code, ensuring it supports both pandas and Polars. | ||
| 4. **Test**: (Include any testing guidelines if applicable, e.g., using `pytest`). | ||
| 5. **Commit and Push**: Commit your changes with clear, descriptive commit messages. | ||
| 6. **Pull Request**: Open a pull request against the main branch. Reference the issue you opened in step 1. | ||
|
|
||
| We look forward to reviewing your contributions! | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good