diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 10194825..5a9533d3 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -1,65 +1,65 @@ -# Contributor Covenant Code of Conduct - -## Our Pledge - -In the interest of fostering an open and welcoming environment, we as -contributors and maintainers pledge to making participation in our -project and our 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. - -## Our Standards - -Examples of behavior that contributes 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 - -## Our 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 e-mail -address, posting via 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 +# 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 c9769609..0bf1d6a7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,56 +1,12 @@ -# Contributing - -We absolutely welcome any code contributions and we hope that this -guide will facilitate an understanding of the ``ansys-tools-repo-sync`` code -repository. It is important to note that while the ``ansys-tools-repo-sync`` software -package is maintained by ANSYS and any submissions will be 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 -questions or submissions to this repository. - -For contributing to this project, please refer to the [PyAnsys Developer's Guide]. - -[PyAnsys Developer's Guide]: https://dev.docs.pyansys.com/index.html - -## Installation - -Installing in developer mode allows you to modify the source and enhance it. - -Before contributing to the project, please refer to the [PyAnsys Developer's guide](https://dev.docs.pyansys.com/). You will -need to follow these steps: - -1. Start by cloning this repository: - - ```bash - git clone https://github.com/ansys/ansys-tools-repo-sync - ``` - -2. Create a fresh-clean Python environment and activate it: - - ```bash - # Create a virtual environment - python -m venv .venv - - # Activate it in a POSIX system - source .venv/bin/activate - - # Activate it in Windows CMD environment - .venv/Scripts/Activate.bat - - # Activate it in Windows Powershell - .venv/Scripts/Activate.ps1 - ``` - -3. Install the project in editable mode: - - ```bash - python -m pip install -e . - ``` - -## Raw testing - -If required, you can always call the style commands ([black](https://black.readthedocs.io/en/stable/), [isort](https://pycqa.github.io/isort/), -[flake8](https://flake8.pycqa.org/en/latest/)) or unit testing ones ([pytest](https://docs.pytest.org/en/stable/)) from the command line. However, -this does not guarantee that your project is being tested in an isolated -environment, which is the reason why tools like [tox](https://tox.readthedocs.io/en/latest/) exist. \ No newline at end of file +# Contribute + +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}. + +The following contribution information is specific to the ``ansys-tools-repo-sync`` repository. + +[Contributing]: https://dev.docs.pyansys.com/how-to/contributing.html + +