Skip to content

Commit bc97e4c

Browse files
authored
doc/Edit contributing.rst (#29)
* doc/Edit contributing.rst * doc/Edit contributing.rst * Update doc/source/overview/contributing.rst * Update doc/source/overview/contributing.rst
1 parent 51306b5 commit bc97e4c

File tree

1 file changed

+40
-43
lines changed

1 file changed

+40
-43
lines changed

doc/source/overview/contributing.rst

Lines changed: 40 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -16,27 +16,25 @@ library appears on the ``Contributing`` page in the respective
1616
library's documentation, including:
1717

1818
- Instructions for cloning the source repository from GitHub
19-
- URL to the library`s ``Issues`` page
20-
- Email address for the library's support team
19+
- URL to the library's ``Issues`` page
2120

22-
For convenience, here are URLs for the ``Issues`` page of
23-
applicable repositories:
21+
For convenience, here are URLs for ``Issues`` pages for
22+
Ansys product repositories:
2423

2524
- `PyAEDT Issues <https://github.com/pyansys/pyaedt/issues>`_
2625
- `PyDPF-Core Issues <https://github.com/pyansys/pydpf-core/issues>`_
2726
- `PyDPF-Post Issues <https://github.com/pyansys/pydpf-post/issues>`_
2827
- `PyMAPDL Issues <https://github.com/pyansys/pymapdl/issues>`_
29-
- `PyMAPDL Reader Issues <https://github.com/pyansys/pymapdl-reader/issues>`_
28+
- `PyMAPDL-Reader Issues <https://github.com/pyansys/pymapdl-reader/issues>`_
3029

31-
The overall PyAnsys project support team can be reached at
32-
[email protected]. Someone will either respond or direct the
33-
message to the respective library's support team.
30+
You can reach the overall PyAnsys project support team at
31+
3432

3533
Submitting Questions
3634
---------------------
3735
For general or technical questions about a PyAnsys library, its
3836
applications, or software usage, create issues on the respective
39-
library's ``Issues`` page. This allows PyAEDT developers and
37+
library's ``Issues`` page. This allows PyAnsys developers and
4038
community members with the needed expertise to collectively address
4139
them. It also makes their responses available to all users.
4240

@@ -45,30 +43,27 @@ Reporting Bugs
4543
If you encounter a bug or your workflow crashes while using a
4644
PyAnsys library, create an issue on the respective library's
4745
``Issues`` page and tag it with an appropriate label so that it
48-
can be promptly addressed. When reporting an issue, be as descriptive
46+
can be promptly addressed. In describing the issue, be as descriptive
4947
as possible so that the issue can be reproduced. Whenever possible,
50-
provide a traceback, screenshots, and sample files to help us address
51-
the issue.
48+
provide a traceback, screenshots, and sample files that might help
49+
the community to address the issue.
5250

5351
Requesting New Features
5452
-----------------------
55-
We encourage you to submit ideas for improvements to PyAnsys libraries.
53+
We encourage you to submit ideas for improving PyAnsys libraries.
5654
To suggest a new feature, create an issue on the respective library's
57-
``Issues`` page and tag it with a ``Feature Request`` label. Use a
55+
``Issues`` page and tag it with the ``Feature Request`` label. Use a
5856
descriptive title and provide ample background information to help the
59-
community implement the desired functionality. For example, if you
60-
would like a reader for a specific file format, provide a link to
61-
documentation for this file format and possibly provide some sample files
62-
and screenshots. We will use the issue thread as a place to discuss the
63-
feature request and provide feedback.
57+
community decide how the feature might be implemented. For example,
58+
if you would like to see a reader added for a specific file format,
59+
in the issue, provide a link to documentation for this file
60+
format and possibly some sample files and screenshots. The community
61+
will then use the issue thread to discuss the request and
62+
provide feedback on how the feature might best be implemented.
6463

6564
Contributing New Code
6665
---------------------
67-
If you have an idea for improving a PyAnsys library, consider first
68-
creating an issue for a new feature request. We will then use this thread
69-
to discuss how best to implement the contribution.
70-
71-
Once you are ready to start coding, see:
66+
When you are ready to start contributing code, see:
7267

7368
- :ref:`development_practices` for information on how development is
7469
conducted in PyAnsys repositories
@@ -77,30 +72,31 @@ Once you are ready to start coding, see:
7772

7873
Starting Discussions
7974
--------------------
80-
In the repository for the respective PyAnsys library, you should raise
81-
general questions regarding development practices as discussions rather
82-
than issues. For example, raise general questions about PyMAPDL
83-
in `PyMAPDL Discussions <https://github.com/pyansys/pymapdl/discussions>`_.
84-
Depending on what is decided, issues can be spun out of general discussions.
75+
For general questions about development practices, you should create discussions
76+
rather than issues. The repository for each PyAnsys library has its own
77+
``Discussions`` page. For example, to ask a question about a PyMAPDL development
78+
practice, you would create a discussion on this library's `Discussions <https://github.com/pyansys/pymapdl/discussions>`_
79+
page. It is possible for discussions to lead to the creation of issues.
8580

8681
.. note::
87-
The discussions feature is still in beta on GitHub, so this may
82+
Because the ``Discussions`` feature is still in beta on GitHub, usage may
8883
change in the future.
8984

9085
Cloning the Source Repository
9186
-----------------------------
9287
As mentioned earlier, specific instructions for cloning a source
9388
repository from GitHub appear on the ``Contributing`` page in the
94-
respective library's documentation. Here is a summary of the code
95-
for cloning and installing the latest version in development:
89+
respective library's documentation. In te following code for cloning and
90+
installing the latest version of a PyAnsys repository, ``<pyansy-repository>``
91+
is a placeholder for the name of the repository.
9692

9793
.. code::
9894
9995
git clone https://github.com/pyansys/<pyansys-repository>
10096
cd <pyansys-repository>
10197
pip install -e .
10298
103-
For example, here is the code for cloning and installing the latest version
99+
For example, you would use this code to clone and installing the latest version
104100
of PyMAPDL:
105101

106102
.. code::
@@ -109,16 +105,17 @@ of PyMAPDL:
109105
cd pymapdl
110106
pip install -e .
111107
112-
Consider creating a `fork <https://docs.github.com/en/get-started/quickstart/fork-a-repo>`_
113-
of the repository if you want to eventually push a contribution to the official
114-
PyAnsys repository. For additional information, see :ref: dev_practices.
108+
If you want to eventually push a contribution to the official
109+
PyAnsys repository, consider creating a `fork <https://docs.github.com/en/get-started/quickstart/fork-a-repo>`_
110+
of the repository. For additional information, see :ref: dev_practices.
115111

116112
Licensing
117113
---------
118-
All contributed code will be licensed under the MIT License found in
119-
the repository. If you did not write the code yourself, it is your
120-
responsibility to ensure that the existing license is compatible and
121-
included in the contributed files. You must obtain permission from the
122-
original author to relicense the code.
123-
124-
See :ref:`license_file` for more information.
114+
All contributed code will be licensed under the MIT License. For more information, see
115+
:ref:`license_file`. The ``LICENSE`` file with the MIT License must be included in
116+
the root directory of the repository for a PyAnsys library.
117+
118+
If you did not write the code that you are contributing yourself, it is your
119+
responsibility to ensure that the existing license for this code is compatible and
120+
included in the contributed files. You must obtain permission from the original
121+
author to relicense the code.

0 commit comments

Comments
 (0)