generated from ansys/template
-
Notifications
You must be signed in to change notification settings - Fork 18
MAINT: general updates #145
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
Revathyvenugopal162
merged 15 commits into
maint/tech-review
from
feat/allign-pyansys-guidelines
Apr 12, 2023
Merged
Changes from all commits
Commits
Show all changes
15 commits
Select commit
Hold shift + click to select a range
7695363
maint: update precommit
Revathyvenugopal162 da707fd
maint: update labeler
Revathyvenugopal162 93f962a
doc: update contributning
Revathyvenugopal162 075d42f
Merge branch 'maint/tech-review' into feat/allign-pyansys-guidelines
Revathyvenugopal162 6a568ed
Merge branch 'maint/tech-review' into feat/allign-pyansys-guidelines
Revathyvenugopal162 8f45603
Apply suggestions from code review
Revathyvenugopal162 78e63e5
Fix: add labeller for dependency
Revathyvenugopal162 a4dbe0e
Doc: fix the header
Revathyvenugopal162 577536a
Doc: fix the vale error
Revathyvenugopal162 0ede368
Merge branch 'maint/tech-review' into feat/allign-pyansys-guidelines
Revathyvenugopal162 e5b9d71
Merge branch 'maint/tech-review' into feat/allign-pyansys-guidelines
Revathyvenugopal162 fecd060
Doc: fix the vale error for sentance case
Revathyvenugopal162 be5169c
Merge branch 'feat/allign-pyansys-guidelines' of https://github.com/p…
Revathyvenugopal162 cd4d86c
maint: remove the proto files
Revathyvenugopal162 a6819ff
Debug: try to remove codecov dependency
Revathyvenugopal162 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 |
---|---|---|
@@ -1,8 +1,76 @@ | ||
Contributing | ||
------------- | ||
============ | ||
|
||
Overall guidance on contributing to a PyAnsys repository appears in the | ||
`Contributing <https://dev.docs.pyansys.com/overview/contributing.html>`_ topic | ||
in the *PyAnsys Developer's Guide*. Ensure that you are thoroughly familiar | ||
with it and all `Guidelines and Best Practices <https://dev.docs.pyansys.com/guidelines/index.html>`_ | ||
before attempting to contribute to PyDyna. | ||
before attempting to contribute to PyDyna. | ||
|
||
The following contribution information is specific to PyDyna. | ||
|
||
Clone the repository | ||
-------------------- | ||
|
||
To clone and install the latest PyDyna release in development mode, run: | ||
|
||
.. code:: | ||
|
||
git clone https://github.com/pyansys/PyDyna | ||
cd PyDyna | ||
python -m pip install --upgrade pip | ||
pip install -e . | ||
|
||
|
||
Post issues | ||
----------- | ||
|
||
Use the `PyDyna Issues <https://github.com/pyansys/PyDyna/issues>`_ | ||
page to submit questions, report bugs, and request new features. When possible, you | ||
should use these issue templates: | ||
|
||
* Bug report template | ||
* Feature request template | ||
|
||
If your issue does not fit into these categories, create your own issue. | ||
|
||
To reach the PyAnsys team, email `pyansys.core@ansys.com <pyansys.core@ansys.com>`_. | ||
|
||
View documentation | ||
------------------ | ||
|
||
Documentation for the latest stable release of PyDyna is hosted at | ||
`PyDyna Documentation <https://dyna.docs.pyansys.com>`_. | ||
|
||
Documentation for the latest development version, which tracks the | ||
``main`` branch, is hosted at `Development PyDyna Documentation <https://dyna.docs.pyansys.com/dev/>`_. | ||
This version is automatically kept up to date via GitHub actions. | ||
|
||
Code style | ||
---------- | ||
|
||
PyDyna follows the PEP8 standard as outlined in the `PyAnsys Development Guide | ||
<https://dev.docs.pyansys.com>`_ and implements style checking using | ||
`pre-commit <https://pre-commit.com/>`_. | ||
|
||
To ensure your code meets minimum code styling standards, run:: | ||
|
||
pip install pre-commit | ||
pre-commit run --all-files | ||
|
||
You can also install this as a pre-commit hook by running:: | ||
|
||
pre-commit install | ||
|
||
This way, it's not possible for you to push code that fails the style checks. For example:: | ||
|
||
$ pre-commit install | ||
$ git commit -am "added my cool feature" | ||
black....................................................................Passed | ||
blacken-docs.............................................................Passed | ||
codespell................................................................Passed | ||
flake8...................................................................Passed | ||
isort....................................................................Passed | ||
check for merge conflicts................................................Passed | ||
debug statements (python)................................................Passed | ||
Validate GitHub Workflows................................................Passed |
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
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I am leaving this comment here but it applies to the header in line 2 of this file.
Headers in our chapter must start with the
#
symbol while sections in chapters use=
.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@jorgepiloto Thanks for pointing that. fixed at a4dbe0e