diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b77db6d65e..007f97120e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,17 +2,16 @@ -We absolutely welcome any code contributions and we hope that this -guide will facilitate an understanding of the PyACP code +We absolutely welcome all code contributions and hope that this +guide facilitates an understanding of the PyACP code repository. It is important to note that while the PyACP software -package is maintained by ANSYS and any submissions will be reviewed +package is maintained by Ansys and any submissions are reviewed thoroughly before merging, we still seek to foster a community that can support user questions and develop new features to make this software -a useful tool for all users. As such, we welcome and encourage any +a useful tool for all users. As such, we welcome and encourage any questions or submissions to this repository. -Please reference the [PyAnsys Developer's -Guide](https://dev.docs.pyansys.com) for the full documentation -regarding contributing to the PyACP project. +For comprehensive documentation on contributing to the PyACP project, +refer to the [PyAnsys developer's guide](https://dev.docs.pyansys.com). diff --git a/doc/source/contributing.rst b/doc/source/contributing.rst index 9cd1fde812..5a8a2ce24d 100644 --- a/doc/source/contributing.rst +++ b/doc/source/contributing.rst @@ -1,21 +1,21 @@ -Contributing -============ +Contribute +========== .. include:: ../../CONTRIBUTING.md :start-after: :end-before: -For example, you could contribute by: +For example, you can make contributions as follows: -- Reporting a bug or suggesting a feature -- Giving feedback or making suggestions for improving the documentation -- Submitting a pull request to fix a bug or add a feature -- Reporting your use case, and how PyACP helped you or what is still missing +- Report a bug or suggest a feature. +- Give feedback or make suggestions for improving the documentation. +- Submit a pull request to fix a bug or add a feature. +- Report your use case, explain how PyACP has helped you, or indicate what features are still missing. -For feedback, suggestions, or bug reports, please open an `issue +For feedback, suggestions, or bug reports, open an `issue `_ on the PyACP GitHub repository. -For code changes or documentation improvements, please open a `pull request +For code changes or documentation improvements, open a `pull request `_.