Skip to content

Commit 3e5f26a

Browse files
authored
Update contributing guidelines in README
Clarified contribution guidelines to emphasize simplicity and support for polars.
1 parent 35ef171 commit 3e5f26a

1 file changed

Lines changed: 11 additions & 1 deletion

File tree

README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -231,4 +231,14 @@ print(change(kpis))
231231

232232
## 🤝 Contributing
233233

234-
Contributions are welcome, provided they align with the repository’s guiding principles. Please review the [contributing](https://github.com/data-centt/percentify/blob/main/CONTRIBUTING.md) guidelines before submitting.
234+
Contributions are welcome but they must follow the repo's guiding principle:
235+
> 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.
236+
237+
**It must support polars.** Every function accepts both pandas and polars objects (via the `@_backend_aware` decorator) and returns the same kind, so any new contribution must keep that parity.
238+
239+
If your idea keeps things that simple and direct:
240+
- Open an issue first to discuss it
241+
- Fork the repo
242+
- Create a branch
243+
- Commit your changes
244+
- Open a pull request

0 commit comments

Comments
 (0)