-
Notifications
You must be signed in to change notification settings - Fork 8
Add branch naming conventions link to Contributing #31
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.
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
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -18,6 +18,23 @@ library's documentation, including: | |
- Instructions for cloning the source repository from GitHub | ||
- URL to the library's ``Issues`` page | ||
|
||
Creating Issues | ||
--------------- | ||
You create issues to submit questions, report bugs, and request new | ||
features. When you create an issue, ensure that you provide sufficient | ||
context, such as application versions and reproduction steps. Also use | ||
an issue label like "Documentation" to indicate the issue category. | ||
|
||
PyAnsys developers and community members will respond to and hopefully | ||
resolve your issue. Once an issue is resolved, you are encouraged to | ||
close it yourself. Otherwise, after a period of inactivity, the PyAnsys | ||
project support team will use discretion as to whether to close it. | ||
|
||
Should it turn out that your issue is closed erroneously, perhaps because | ||
a bug fix implemented to resolve your issue did not work, you can re-open | ||
it with a comment that explains why you have done so. If you need to contact the | ||
PyAnsys project support team directly, email `[email protected] <[email protected]>`_. | ||
|
||
For convenience, here are URLs for ``Issues`` pages for | ||
Ansys product repositories: | ||
|
||
|
@@ -27,19 +44,16 @@ Ansys product repositories: | |
- `PyMAPDL Issues <https://github.com/pyansys/pymapdl/issues>`_ | ||
- `PyMAPDL-Reader Issues <https://github.com/pyansys/pymapdl-reader/issues>`_ | ||
|
||
You can reach the overall PyAnsys project support team at | ||
'[email protected] <[email protected]>`_. | ||
|
||
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 PyAnsys developers and | ||
community members with the needed expertise to collectively address | ||
them. It also makes their responses available to all users. | ||
|
||
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 | ||
|
@@ -49,7 +63,7 @@ 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 improving PyAnsys libraries. | ||
To suggest a new feature, create an issue on the respective library's | ||
``Issues`` page and tag it with the ``Feature Request`` label. Use a | ||
|
@@ -79,14 +93,14 @@ practice, you would create a discussion on this library's `Discussions <https:// | |
page. It is possible for discussions to lead to the creation of issues. | ||
|
||
.. note:: | ||
Because the ``Discussions`` feature is still in beta on GitHub, usage may | ||
change in the future. | ||
Because the ``Discussions`` page is still a beta feature 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. In te following code for cloning and | ||
respective library's documentation. In the following code for cloning and | ||
installing the latest version of a PyAnsys repository, ``<pyansy-repository>`` | ||
is a placeholder for the name of the repository. | ||
|
||
|
@@ -96,8 +110,8 @@ is a placeholder for the name of the repository. | |
cd <pyansys-repository> | ||
pip install -e . | ||
|
||
For example, you would use this code to clone and installing the latest version | ||
of PyMAPDL: | ||
For example, to clone and install the latest version of PyMAPDL, | ||
you would run the following: | ||
|
||
.. code:: | ||
|
||
|
@@ -107,7 +121,9 @@ of PyMAPDL: | |
|
||
If you want to eventually push a contribution to the official | ||
PyAnsys repository, consider creating a `fork <https://docs.github.com/en/get-started/quickstart/fork-a-repo>`_ | ||
of the repository. For additional information, see :ref: dev_practices. | ||
of the repository. For information on how to contribute through | ||
GitHub, see :ref:`development_practices`, paying particular attention to :ref:`branch_naming` | ||
when you are ready to create a pull request. | ||
|
||
Licensing | ||
--------- | ||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.