@@ -7,8 +7,8 @@ As time passes, some libraries may become outdated or replaced by better alterna
7
7
When this happens, it is important to deprecate the old library properly to ensure users
8
8
are aware of the change and can transition smoothly.
9
9
10
- In the PyAnsys ecosystem, we follow a specific process for deprecating libraries.
11
- This process helps maintain clarity and consistency across our projects.
10
+ For the PyAnsys ecosystem, follow this specific process for deprecating libraries.
11
+ This process helps maintain clarity and consistency across the projects.
12
12
13
13
Maintainer tasks
14
14
----------------
@@ -28,14 +28,14 @@ is used in this guide.
28
28
open issues and pull requests in the library's repository are closed. This helps to avoid
29
29
confusion and ensures that users are aware that the library is no longer actively maintained.
30
30
You can close issues and pull requests with a comment explaining that the library is being
31
- deprecated and will no longer be supported.
31
+ deprecated and is no longer be supported.
32
32
3. **Create a deprecation issue **: Open an issue in the library's repository to announce the
33
33
deprecation. This issue should explain why the library is being deprecated, what alternatives
34
34
are available, and any relevant timelines. See a template below for the issue content.
35
35
36
36
.. warning ::
37
37
38
- Make sure to adapt the template to your specific library and situation!
38
+ Make sure to adapt the template to your specific library and situation.
39
39
40
40
.. code :: markdown
41
41
@@ -58,7 +58,7 @@ is used in this guide.
58
58
59
59
Thank you to everyone who contributed, used, or supported this project!
60
60
61
- This issue will serve as a permanent record of the deprecation and provide users with
61
+ This issue serves as a permanent record of the deprecation and provide users with
62
62
necessary information about alternatives.
63
63
64
64
Make sure to pin the issue to the top of the repository so that it is easily visible to users.
@@ -89,12 +89,12 @@ is used in this guide.
89
89
90
90
6. **(Optional) Make a last release **: If you carried out step 5, consider making a final release
91
91
of the library that includes the deprecation warning. This ensures that users who install
92
- the library in the future will see the warning immediately.
92
+ the library in the future see the warning immediately.
93
93
94
94
7. **Archive the repository **: Once the deprecation issue is created and the README is updated,
95
- you can archive the repository. This will prevent any further changes to the repository and
96
- signal to users that the library is no longer maintained. To archive a repository, go to the
97
- repository settings and select "Archive this repository".
95
+ you can archive the repository. This prevents any further changes to the repository and
96
+ signals to users that the library is no longer maintained. To archive a repository, go to the
97
+ repository settings and select "Archive this repository."
98
98
99
99
These steps ensure that the deprecation process is clear and transparent, allowing users to
100
100
transition smoothly to alternatives while maintaining the integrity of the PyAnsys ecosystem.
@@ -107,7 +107,7 @@ transition smoothly to alternatives while maintaining the integrity of the PyAns
107
107
Core team tasks
108
108
---------------
109
109
110
- The PyAnsys Core team will assist with the deprecation process by:
110
+ The PyAnsys Core team is responsbile for assisting with the deprecation process by:
111
111
112
112
- Reviewing the deprecation issue to ensure it meets the project's standards.
113
113
- Assisting with the above steps, if necessary.
0 commit comments