From 41d5c6c512c947cfdd7e623470562526debebb94 Mon Sep 17 00:00:00 2001 From: Kathy Pippert Date: Thu, 13 Jan 2022 16:18:20 -0500 Subject: [PATCH 1/4] doc/Edit contributing.rst --- doc/source/overview/contributing.rst | 82 ++++++++++++++-------------- 1 file changed, 40 insertions(+), 42 deletions(-) diff --git a/doc/source/overview/contributing.rst b/doc/source/overview/contributing.rst index 8d98bfdab..6e1289de3 100644 --- a/doc/source/overview/contributing.rst +++ b/doc/source/overview/contributing.rst @@ -16,27 +16,25 @@ library appears on the ``Contributing`` page in the respective library's documentation, including: - Instructions for cloning the source repository from GitHub -- URL to the library`s ``Issues`` page -- Email address for the library's support team +- URL to the library's ``Issues`` page -For convenience, here are URLs for the ``Issues`` page of -applicable repositories: +For convenience, here are URLs for ``Issues`` pages for +Ansys product repositories: - `PyAEDT Issues `_ - `PyDPF-Core Issues `_ - `PyDPF-Post Issues `_ - `PyMAPDL Issues `_ -- `PyMAPDL Reader Issues `_ +- `PyMAPDL-Reader Issues `_ -The overall PyAnsys project support team can be reached at -pyansys.support@ansys.com. Someone will either respond or direct the -message to the respective library's support team. +You can reach the overall PyAnsys project support team at +'pyansys.support@ansys.com `_. Submitting Questions --------------------- For general or technical questions about a PyAnsys library, its applications, or software usage, create issues on the respective -library's ``Issues`` page. This allows PyAEDT developers and +library's ``Issues`` page. This allows PyAnsys developers and community members with the needed expertise to collectively address them. It also makes their responses available to all users. @@ -45,30 +43,27 @@ Reporting Bugs If you encounter a bug or your workflow crashes while using a PyAnsys library, create an issue on the respective library's ``Issues`` page and tag it with an appropriate label so that it -can be promptly addressed. When reporting an issue, be as descriptive +can be promptly addressed. In describing the issue, be as descriptive as possible so that the issue can be reproduced. Whenever possible, -provide a traceback, screenshots, and sample files to help us address -the issue. +provide a traceback, screenshots, and sample files that might help +the community to address the issue. Requesting New Features ----------------------- -We encourage you to submit ideas for improvements to PyAnsys libraries. +We encourage you to submit ideas for improving PyAnsys libraries. To suggest a new feature, create an issue on the respective library's -``Issues`` page and tag it with a ``Feature Request`` label. Use a +``Issues`` page and tag it with the ``Feature Request`` label. Use a descriptive title and provide ample background information to help the -community implement the desired functionality. For example, if you -would like a reader for a specific file format, provide a link to -documentation for this file format and possibly provide some sample files -and screenshots. We will use the issue thread as a place to discuss the -feature request and provide feedback. +community decide how the feature might be implemented. For example, +if you would like to see a reader added for a specific file format, +in the issue, provide a link to documentation for this file +format and possibly some sample files and screenshots. The community +will then use the issue thread to discuss the request and +provide feedback on how the feature might best be implemented. Contributing New Code --------------------- -If you have an idea for improving a PyAnsys library, consider first -creating an issue for a new feature request. We will then use this thread -to discuss how best to implement the contribution. - -Once you are ready to start coding, see: +When you are ready to start contributing code, see: - :ref:`development_practices` for information on how development is conducted in PyAnsys repositories @@ -77,22 +72,23 @@ Once you are ready to start coding, see: Starting Discussions -------------------- -In the repository for the respective PyAnsys library, you should raise -general questions regarding development practices as discussions rather -than issues. For example, raise general questions about PyMAPDL -in `PyMAPDL Discussions `_. -Depending on what is decided, issues can be spun out of general discussions. +For general questions about development practices, you should create discussions +rather than issues. The repository for each PyAnsys library has its own +``Discussions`` page. For example, to ask a question about an PyMAPDL development +practice, you would create a discussion on this library's `Discussions `_ +page. It is possible for discussions to lead to the creation of issues. .. note:: - The discussions feature is still in beta on GitHub, so this may + Because the ``Discussions`` feature is still in beta on GitHub, usage may change in the future. Cloning the Source Repository ----------------------------- As mentioned earlier, specific instructions for cloning a source repository from GitHub appear on the ``Contributing`` page in the -respective library's documentation. Here is a summary of the code -for cloning and installing the latest version in development: +respective library's documentation. In te following code for cloning and +installing the latest version of a PyAnsys repository, ```` +is a placeholder for the name of the repository. .. code:: @@ -100,7 +96,7 @@ for cloning and installing the latest version in development: cd pip install -e . -For example, here is the code for cloning and installing the latest version +For example, you would use this code to clone and installing the latest version of PyMAPDL: .. code:: @@ -109,16 +105,18 @@ of PyMAPDL: cd pymapdl pip install -e . -Consider creating a `fork `_ -of the repository if you want to eventually push a contribution to the official -PyAnsys repository. For additional information, see :ref: dev_practices. +If you want to eventually push a contribution to the official +PyAnsys repository, consider creating a `fork `_ +of the repository. For additional information, see :ref: dev_practices. Licensing --------- -All contributed code will be licensed under the MIT License found in -the repository. If you did not write the code yourself, it is your -responsibility to ensure that the existing license is compatible and -included in the contributed files. You must obtain permission from the -original author to relicense the code. +All contributed code will be licensed under the MIT License. For more information, see +for more information. The ``LICENSE`` file with the MIT License must be included in +the root directory of the repository for a PyAnsys library. + +If you did not write the code that you are contributing yourself, it is your +responsibility to ensure that the existing license for this code is compatible and +included in the contributed files. You must obtain permission from the original +author to relicense the code. -See :ref:`license_file` for more information. From fd6ec2d8f3f3cb3c0165a4c5ebbdbec5d12a139e Mon Sep 17 00:00:00 2001 From: Kathy Pippert Date: Thu, 13 Jan 2022 16:20:16 -0500 Subject: [PATCH 2/4] doc/Edit contributing.rst --- doc/source/overview/contributing.rst | 1 - 1 file changed, 1 deletion(-) diff --git a/doc/source/overview/contributing.rst b/doc/source/overview/contributing.rst index 6e1289de3..c8d532e22 100644 --- a/doc/source/overview/contributing.rst +++ b/doc/source/overview/contributing.rst @@ -119,4 +119,3 @@ If you did not write the code that you are contributing yourself, it is your responsibility to ensure that the existing license for this code is compatible and included in the contributed files. You must obtain permission from the original author to relicense the code. - From 0b53e16afe7d8196f87c59d53b24dde2ff03841e Mon Sep 17 00:00:00 2001 From: Kathy Pippert <84872299+PipKat@users.noreply.github.com> Date: Thu, 13 Jan 2022 17:16:29 -0500 Subject: [PATCH 3/4] Update doc/source/overview/contributing.rst --- doc/source/overview/contributing.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/source/overview/contributing.rst b/doc/source/overview/contributing.rst index c8d532e22..d189a672f 100644 --- a/doc/source/overview/contributing.rst +++ b/doc/source/overview/contributing.rst @@ -74,7 +74,7 @@ Starting Discussions -------------------- For general questions about development practices, you should create discussions rather than issues. The repository for each PyAnsys library has its own -``Discussions`` page. For example, to ask a question about an PyMAPDL development +``Discussions`` page. For example, to ask a question about a PyMAPDL development practice, you would create a discussion on this library's `Discussions `_ page. It is possible for discussions to lead to the creation of issues. From 55ee19b9eb2c2b3290fdddb96d2a0c98a7ae2168 Mon Sep 17 00:00:00 2001 From: Kathy Pippert <84872299+PipKat@users.noreply.github.com> Date: Thu, 13 Jan 2022 17:18:22 -0500 Subject: [PATCH 4/4] Update doc/source/overview/contributing.rst --- doc/source/overview/contributing.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/source/overview/contributing.rst b/doc/source/overview/contributing.rst index d189a672f..85b8c40b7 100644 --- a/doc/source/overview/contributing.rst +++ b/doc/source/overview/contributing.rst @@ -112,7 +112,7 @@ of the repository. For additional information, see :ref: dev_practices. Licensing --------- All contributed code will be licensed under the MIT License. For more information, see -for more information. The ``LICENSE`` file with the MIT License must be included in +:ref:`license_file`. The ``LICENSE`` file with the MIT License must be included in the root directory of the repository for a PyAnsys library. If you did not write the code that you are contributing yourself, it is your