diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000000..5a9533d3ca --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,65 @@ +# Contributor covenant code of conduct + +## Pledge + +In the interest of fostering an open and welcoming environment, +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, socioeconomic status, nationality, personal +appearance, race, religion, or sexual identity and orientation. + +## Standards + +Examples of behavior that contribute to creating a positive environment +include: + +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* Gracefully accepting constructive criticism +* Focusing on what is best for the community +* Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery and unwelcome sexual + attention or advances +* Trolling, insulting/derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or electronic + address, without explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable +behavior and are expected to take appropriate and fair corrective action in +response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are +not aligned to this Code of Conduct, or to ban temporarily or permanently any +contributor for other behaviors that they deem inappropriate, threatening, +offensive, or harmful. + +## Scope + +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 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. + +## Attribution + +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 779c69147f..5d752a14cf 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,36 +3,10 @@ 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 -PyPrimeMesh. +{project-name}. -The following contribution information is specific to PyPrimeMesh. +The following contribution information is specific to {project-name}. [Contributing]: https://dev.docs.pyansys.com/how-to/contributing.html -## Run tests locally - -Run tests locally with this command: - -```bash - pytest -``` - -Note that you must have access to PyPrimeMesh to run the tests. -Some of the graphical-related tests must have a previously generated image cache, so -you might get errors due to this. - -## Build documentation - -To build PyPrimeMesh documentation, run this command. - -In Windows: -```bash - ./doc/make.bat html - ./doc/make.bat pdf -``` - -In Linux: -```bash - make html - make pdf -``` \ No newline at end of file + diff --git a/doc/changelog.d/1175.miscellaneous.md b/doc/changelog.d/1175.miscellaneous.md new file mode 100644 index 0000000000..1d98c69033 --- /dev/null +++ b/doc/changelog.d/1175.miscellaneous.md @@ -0,0 +1 @@ +CHORE: Update missing or outdated files