Skip to content

Commit

Permalink
Merge pull request #162 from WenjieDu/dev
Browse files Browse the repository at this point in the history
Updating workflows and docs
  • Loading branch information
WenjieDu authored Jul 20, 2023
2 parents ec072ba + dbf342c commit a9899d7
Show file tree
Hide file tree
Showing 5 changed files with 24 additions and 12 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/greetings.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ jobs:
issue-message: |
Hi there 👋,
Thank you so much for your attention to PyPOTS! If you find PyPOTS helpful to your work, please star⭐️ this repository. Your star is your recognition, which can help more people notice PyPOTS and grow PyPOTS community. It matters and is definitely a kind of contribution to the community.
Thank you so much for your attention to PyPOTS! You can follow me on GitHub to receive the latest news of PyPOTS. If you find PyPOTS helpful to your work, please star⭐️ this repository. Your star is your recognition, which can help more people notice PyPOTS and grow PyPOTS community. It matters and is definitely a kind of contribution to the community.
I have received your message and will respond ASAP. Thank you for your patience! 😃
Expand Down
8 changes: 4 additions & 4 deletions .github/workflows/stale.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,11 @@ jobs:
steps:
- uses: actions/stale@v8
with:
stale-issue-message: 'This issue had no activity for **30 days**. It will be closed in **2 weeks** unless there is some new activity. Is this issue already resolved?'
stale-issue-message: 'This issue had no activity for **14 days**. It will be closed in **1 week** unless there is some new activity. Is this issue already resolved?'
stale-issue-label: 'stale'
exempt-issue-labels: 'bug,enhancement,good first issue,keep'
stale-pr-message: 'This pull request had no activity for **30 days**. It will be closed in **2 weeks** unless there is some new activity.'
stale-pr-message: 'This pull request had no activity for **14 days**. It will be closed in **1 week** unless there is some new activity.'
stale-pr-label: 'stale'
days-before-stale: 30
days-before-close: 14
days-before-stale: 14
days-before-close: 7
operations-per-run: 200
3 changes: 1 addition & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -216,8 +216,7 @@ By committing your code, you'll
Take a look at our [inclusion criteria](https://docs.pypots.com/en/latest/faq.html#inclusion-criteria).
You can utilize the `template` folder in each task package (e.g.
[pypots/imputation/template](https://github.com/WenjieDu/PyPOTS/tree/main/pypots/imputation/template)) to quickly start;
2. be listed as one of [PyPOTS contributors](https://github.com/WenjieDu/PyPOTS/graphs/contributors):
<img align="center" src="https://contrib.rocks/image?repo=wenjiedu/pypots">;
2. be listed as one of [PyPOTS contributors](https://pypots.com/about/#all-contributors);
3. get mentioned in our [release notes](https://github.com/WenjieDu/PyPOTS/releases);
You can also contribute to PyPOTS by simply staring🌟 this repo to help more people notice it.
Expand Down
17 changes: 15 additions & 2 deletions docs/faq.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,10 @@ published for at least 1 year, have 20+ citations, and the usefulness to our use
to help boost research accessibility and reproducibility in the field of POTS modeling.
Note this exception only applies if you commit to the maintenance of your model for at least two years.


Becoming a Maintainer
Join PyPOTS
^^^^^^^^^^^^^^^^^^^^^
Becoming a Maintainer
"""""""""""""""""""""
To join the team and become a maintainer of PyPOTS, you should

1. be active on GitHub and watch PyPOTS repository to receive the latest news from it;
Expand All @@ -35,6 +36,18 @@ and
You can take a leave of absence from the role with notice at any time.
But if you're inactive for a long time (more than three months. With reasons, a longer period is allowed for sure), your role will be deactivated.

Becoming a Lead
"""""""""""""""
To become a lead at PyPOTS, surely you have to already obtain a maintainer role first.
Your research should be highly related to data mining/machine learning on POTS data, and
you have to prove that you're capable of proposing a research plan solely and conducting it.
You're willing to take developing PyPOTS as your responsibility and commit to constantly and regularly
contribute you time and ideas to PyPOTS things (including community culture construction,
code maintenance, current research implementation, new research planning).

If you believe you want to do this, you can drop an email with anything you want to tell and your CV attachment to
`team@pypots.com <mailto:team@pypots.com>`_. We will schedule a meeting for you and all other leads at PyPOTS for further discussion.


Our Development Principles
^^^^^^^^^^^^^^^^^^^^^^^^^^
Expand Down
6 changes: 3 additions & 3 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. PyPOTS documentation master file
.. PyPOTS documentation index page
Created by Wenjie Du <wenjay.du@gmail.com>
License: GPL-v3
Expand Down Expand Up @@ -28,7 +28,7 @@ Welcome to PyPOTS docs!

.. image:: https://img.shields.io/badge/join_us-community!-C8A062
:alt: Community
:target: #id16
:target: #id17

.. image:: https://img.shields.io/github/contributors/wenjiedu/pypots?color=D8E699&label=Contributors&logo=GitHub
:alt: GitHub Contributors
Expand Down Expand Up @@ -76,7 +76,7 @@ Welcome to PyPOTS docs!

⦿ `Mission`: PyPOTS is born to become a handy toolbox that is going to make data mining on POTS easy rather than tedious, to help engineers and researchers focus more on the core problems in their hands rather than on how to deal with the missing parts in their data. PyPOTS will keep integrating classical and the latest state-of-the-art data mining algorithms for partially-observed multivariate time series. For sure, besides various algorithms, PyPOTS is going to have unified APIs together with detailed documentation and interactive examples across algorithms as tutorials.

👍 **Please** star this repo to help others notice PyPOTS if you think it is a useful toolkit.
🤗 **Please** star this repo to help others notice PyPOTS if you think it is a useful toolkit.
**Please** properly `cite PyPOTS <https://docs.pypots.com/en/latest/milestones.html#citing-pypots>`_ in your publications
if it helps with your research. This really means a lot to our open-source research. Thank you!

Expand Down

0 comments on commit a9899d7

Please sign in to comment.