diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 5b1310ab8..5a9533d3c 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -7,7 +7,7 @@ all contributors and maintainers pledge to making participation in the Ansys project and community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, sex characteristics, gender identity and expression, level of -experience, education, socio-economic status, nationality, personal +experience, education, socioeconomic status, nationality, personal appearance, race, religion, or sexual identity and orientation. ## Standards @@ -49,7 +49,7 @@ offensive, or harmful. This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project email -address, posting via an official social media account, or acting as an appointed +address, posting using an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers. @@ -57,9 +57,9 @@ further defined and clarified by project maintainers. This code of conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at - +https://www.contributor-covenant.org/version/1/4/code-of-conduct.html [homepage]: https://www.contributor-covenant.org For answers to common questions about this code of conduct, see - +https://www.contributor-covenant.org/faq diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index cd4ca7f12..5d752a14c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,34 +1,12 @@ -# Contributing +# Contribute -Please, refer to the [PyAnsys Developer's Guide] for contributing to this project. +Overall guidance on contributing to a PyAnsys library appears in the +[Contributing] topic in the *PyAnsys developer's guide*. Ensure that you +are thoroughly familiar with this guide before attempting to contribute to +{project-name}. -[PyAnsys Developer's Guide]: https://dev.docs.pyansys.com/index.html +The following contribution information is specific to {project-name}. -The following contribution information is specific to PyAdditive. +[Contributing]: https://dev.docs.pyansys.com/how-to/contributing.html -## Cloning the repository - -To clone PyAdditive and install the dependencies for development, run: - -```text - git clone https://github.com/ansys/pyadditive - cd pyadditive - python -m venv .venv - source .venv/bin/activate # or .venv\Scripts\activate.bat on Windows - python -m pip install --upgrade pip - pip install -e . -``` - -## Posting issues - -Use the [PyAdditive Issues] page to submit questions, report bugs, and request new features. - -[PyAdditive Issues]: https://github.com/ansys/pyadditive/issues - -## Reading documentation - -Documentation for the latest stable release of PyAdditive is hosted at [PyAdditive Documentation](https://additive.docs.pyansys.com/version/stable/). - -## Getting help - -To reach the PyAnsys support team, email . +