Skip to content

Doc/minor edits #577

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 10, 2024
Merged

Doc/minor edits #577

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2f0556c
Standardize "Contribute" heading and make minor edits for overall doc…
PipKat Sep 10, 2024
4c7ad22
minor edits
PipKat Sep 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 6 additions & 7 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,16 @@

<!-- START_MARKER_FOR_SPHINX_DOCS -->

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.

<!-- END_MARKER_FOR_SPHINX_DOCS -->

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).
18 changes: 9 additions & 9 deletions doc/source/contributing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
Contributing
============
Contribute
==========


.. include:: ../../CONTRIBUTING.md
:start-after: <!-- START_MARKER_FOR_SPHINX_DOCS -->
:end-before: <!-- END_MARKER_FOR_SPHINX_DOCS -->

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
<https://github.com/ansys/pyacp/issues>`_ 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
<https://github.com/ansys/pyacp/pulls>`_.


Expand Down