Merge pull request #58 from philip-ndikum/acknowledge-contributors

ci: contributor acknowledgement process

Author: philip-ndikum

.all-contributorsrc

@@ -0,0 +1,17 @@
+on:
+    push:
+        branches:
+            - main
+
+jobs:
+    contrib-readme-job:
+        runs-on: ubuntu-latest
+        name: A job to automate contributions in readme
+        permissions:
+          contents: write
+          pull-requests: write
+        steps:
+            - name: Contribute List
+              uses: akhilmhdh/contributors-readme-action@v2.3.10
+              env:
+                  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/main.yml

@@ -338,6 +338,12 @@ Once Hatch and pre-commit are installed, checks run automatically before each co
 > TIP:
 Most IDEs and text editors have plugins to help adhere these standards.
 
+---
+## Acknowledgements
+We believe every contribution is valuable and appreciate the time and effort you invest in TemporalScope.  
+As a token of our appreciation, we will acknowledge all contributors in the project's documentation and on the GitHub README.  
+If you would like to be recognized differently or remain anonymous, please let us know.
+
 ---
 ## Reporting Issues & Requesting Features
 

CONTRIBUTING.md

@@ -61,7 +61,6 @@
                 <a href="https://img.shields.io/badge/License-Apache%202.0-green">
                     <img src="https://img.shields.io/badge/License-Apache%202.0-green" alt="License">
                 </a>
-                <img src="https://img.shields.io/github/all-contributors/projectOwner/projectName?color=ee8449&style=flat-square" alt="All Contributors">
             </td>
         </tr>
         <tr>
@@ -109,15 +108,17 @@
 This package is flexible and extensible, supporting frameworks like **Pandas, Polars, Modin, Dask, and PyArrow** via **native Narwhals compatibility**. Additionally, the optional _Clara LLM_ modules (etymology from the word _Clarity_) are intended to serve as a model-validation tool to support explainability efforts (XAI).  
 > NOTE: TemporalScope is currently in **beta and pre-release** phase, so some installation methods may not work as expected on all platforms.
 
+
 <!-- --8<-- [end:HOME] -->
-### Table of Contents
+## Table of Contents
 
 - [**Installation**](#installation)
 - [**Usage**](#usage)
   - [**Industrial Academic Applications**](#industrial-academic-applications)
 - [Development Roadmap \& Changelog](#development-roadmap--changelog)
 - [**Contributing**](#contributing)
-  - [**Contributors 💠**](#contributors-)
+  - [**Collaborators**](#collaborators)
+  - [**Contributors**](#contributors)
 - [Cite this Project](#cite-this-project)
 - [**License, Limitations, and Legal Notice**](#license-limitations-and-legal-notice)
 
@@ -215,7 +216,8 @@ for partition_name, predictions in results.items():
 ```
 <!-- --8<-- [end:USAGE] -->
 
-### Industrial Academic Applications
+
+## Industrial Academic Applications
 
 **DISCLAIMER**: The following use cases are provided for academic and informational purposes only. TemporalScope is intended to support research and development in understanding temporal dynamics in feature importance. These examples are not intended as guidance for industrial applications without further validation and expert consultation. The use of TemporalScope in any industrial or production environment is at the user's own risk, and the developers disclaim any liability for such use. Please refer to the [License and Legal Notice](#license-and-legal-notice) for further details.
 
@@ -228,32 +230,33 @@ for partition_name, predictions in results.items():
 
 For more detailed examples from sectors like engineering and other scientific applications, please refer to the [SCIENTIFIC_LITERATURE.md](SCIENTIFIC_LITERATURE.md).
 
+
 ## Development Roadmap & Changelog
 
 For detailed test, security, and deployment workflows as defined by OpenSSF Best Practices, please refer to [CONTRIBUTING.md](CONTRIBUTING.md). **TemporalScope** follows **Semantic Versioning (SemVer)**, a versioning system that conveys the scope of changes introduced in each new release. Each version is represented in the form **MAJOR.MINOR.PATCH**, where major releases introduce significant or breaking changes, minor releases add backward-compatible functionality, and patch releases are used for bug fixes or minor improvements. Below is the planned roadmap outlining feature development and milestones over the next 12–18 months. This roadmap is subject to change based on user feedback, emerging research, and community contributions.
 
+
 ## Contributing
 
 TemporalScope was conceived independently by [Philip Ndikum](https://github.com/philip-ndikum), [Serge Ndikum](https://github.com/serge-ndikum), and [Kane Norman](https://github.com/kanenorman) and has since been open-sourced to the broader academic and developer community. As the software continues to grow and evolve, it relies heavily on the active participation and contributions of its users. We encourage contributions from developers, researchers, and data scientists who are passionate about advancing open-source tools. Whether you are interested in extending the package’s functionality, fixing bugs, or improving documentation, your contributions are vital to the project’s ongoing success.
 
 For detailed guidelines on how to contribute, please refer to our [CONTRIBUTING.md](CONTRIBUTING.md). By working together, we can ensure that TemporalScope remains an innovative and reliable tool, continuously refined through community collaboration.
 
 <!-- --8<-- [start:CONTRIBUTORS] -->
+Thank you to all of these people who have contributed to TemporalScope!
+## Collaborators
 
-## Contributors
-Thanks to these wonderful people who have contributed to TemporalScope:
-
-<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
-<!-- prettier-ignore-start -->
-<!-- markdownlint-disable -->
+<!-- readme: collaborators -start -->
+<!-- readme: collaborators -end -->
 
-<!-- markdownlint-restore -->
-<!-- prettier-ignore-end -->
+## Contributors
 
-<!-- ALL-CONTRIBUTORS-LIST:END -->
+<!-- readme: contributors -start -->
+<!-- readme: contributors -end -->
 
 <!-- --8<-- [end:CONTRIBUTORS] -->
 
+
 ## Cite this Project
 <!-- --8<-- [start:CITATION] -->
 If you use TemporalScope in your research, please consider citing it:
@@ -279,7 +282,7 @@ By using this package, you agree to comply with the terms and conditions set for
 <!-- --8<-- [end:LICENSE] -->
 
 <!-- --8<-- [start:LEGAL] -->
-### Legal Notice
+## Legal Notice
 THIS SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES, OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT, OR OTHERWISE, ARISING FROM, OUT OF, OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 THIS SOFTWARE IS INTENDED FOR ACADEMIC AND INFORMATIONAL PURPOSES ONLY. IT SHOULD NOT BE USED IN PRODUCTION ENVIRONMENTS OR FOR CRITICAL DECISION-MAKING WITHOUT PROPER VALIDATION. ANY USE OF THIS SOFTWARE IS AT THE USER'S OWN RISK.