Skip to content

Commit f7ed155

Browse files
CHORE: Update missing or outdated files (#8763)
Co-authored-by: Roberto Pastor Muela <37798125+RobPasMue@users.noreply.github.com>
1 parent 65db261 commit f7ed155

File tree

2 files changed

+77
-121
lines changed

2 files changed

+77
-121
lines changed

CODE_OF_CONDUCT.md

Lines changed: 65 additions & 65 deletions
Original file line numberDiff line numberDiff line change
@@ -1,65 +1,65 @@
1-
# Contributor Covenant Code of Conduct
2-
3-
## Our Pledge
4-
5-
In the interest of fostering an open and welcoming environment, we as
6-
contributors and maintainers pledge to making participation in our
7-
project and our community a harassment-free experience for everyone,
8-
regardless of age, body size, disability, ethnicity, sex
9-
characteristics, gender identity and expression, level of experience,
10-
education, socioeconomic status, nationality, personal appearance,
11-
race, religion, or sexual identity and orientation.
12-
13-
## Our Standards
14-
15-
Examples of behavior that contributes to creating a positive environment
16-
include:
17-
18-
* Using welcoming and inclusive language
19-
* Being respectful of differing viewpoints and experiences
20-
* Gracefully accepting constructive criticism
21-
* Focusing on what is best for the community
22-
* Showing empathy towards other community members
23-
24-
Examples of unacceptable behavior by participants include:
25-
26-
* The use of sexualized language or imagery and unwelcome sexual
27-
attention or advances
28-
* Trolling, insulting/derogatory comments, and personal or political attacks
29-
* Public or private harassment
30-
* Publishing others' private information, such as a physical or electronic
31-
address, without explicit permission
32-
* Other conduct which could reasonably be considered inappropriate in a
33-
professional setting
34-
35-
## Our Responsibilities
36-
37-
Project maintainers are responsible for clarifying the standards of acceptable
38-
behavior and are expected to take appropriate and fair corrective action in
39-
response to any instances of unacceptable behavior.
40-
41-
Project maintainers have the right and responsibility to remove, edit, or reject
42-
comments, commits, code, wiki edits, issues, and other contributions that are
43-
not aligned to this Code of Conduct, or to ban temporarily or permanently any
44-
contributor for other behaviors that they deem inappropriate, threatening,
45-
offensive, or harmful.
46-
47-
## Scope
48-
49-
This Code of Conduct applies both within project spaces and in public spaces
50-
when an individual is representing the project or its community. Examples of
51-
representing a project or community include using an official project e-mail
52-
address, posting via an official social media account, or acting as an appointed
53-
representative at an online or offline event. Representation of a project may be
54-
further defined and clarified by project maintainers.
55-
56-
## Attribution
57-
58-
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
59-
version 1.4, available at
60-
https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
61-
62-
[homepage]: https://www.contributor-covenant.org
63-
64-
For answers to common questions about this code of conduct, see
65-
https://www.contributor-covenant.org/faq
1+
# Contributor covenant code of conduct
2+
3+
## Pledge
4+
5+
In the interest of fostering an open and welcoming environment,
6+
all contributors and maintainers pledge to making participation
7+
in the Ansys project and community a harassment-free experience
8+
for everyone, regardless of age, body size, disability, ethnicity,
9+
sex characteristics, gender identity and expression, level of
10+
experience, education, socioeconomic status, nationality, personal
11+
appearance, race, religion, or sexual identity and orientation.
12+
13+
## Standards
14+
15+
Examples of behavior that contribute to creating a positive environment
16+
include:
17+
18+
* Using welcoming and inclusive language
19+
* Being respectful of differing viewpoints and experiences
20+
* Gracefully accepting constructive criticism
21+
* Focusing on what is best for the community
22+
* Showing empathy towards other community members
23+
24+
Examples of unacceptable behavior by participants include:
25+
26+
* The use of sexualized language or imagery and unwelcome sexual
27+
attention or advances
28+
* Trolling, insulting/derogatory comments, and personal or political attacks
29+
* Public or private harassment
30+
* Publishing others' private information, such as a physical or electronic
31+
address, without explicit permission
32+
* Other conduct which could reasonably be considered inappropriate in a
33+
professional setting
34+
35+
## Responsibilities
36+
37+
Project maintainers are responsible for clarifying the standards of acceptable
38+
behavior and are expected to take appropriate and fair corrective action in
39+
response to any instances of unacceptable behavior.
40+
41+
Project maintainers have the right and responsibility to remove, edit, or reject
42+
comments, commits, code, wiki edits, issues, and other contributions that are
43+
not aligned to this Code of Conduct, or to ban temporarily or permanently any
44+
contributor for other behaviors that they deem inappropriate, threatening,
45+
offensive, or harmful.
46+
47+
## Scope
48+
49+
This Code of Conduct applies both within project spaces and in public spaces
50+
when an individual is representing the project or its community. Examples of
51+
representing a project or community include using an official project email
52+
address, posting using an official social media account, or acting as an appointed
53+
representative at an online or offline event. Representation of a project may be
54+
further defined and clarified by project maintainers.
55+
56+
## Attribution
57+
58+
This code of conduct is adapted from the [Contributor Covenant][homepage],
59+
version 1.4, available at
60+
https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
61+
62+
[homepage]: https://www.contributor-covenant.org
63+
64+
For answers to common questions about this code of conduct, see
65+
https://www.contributor-covenant.org/faq

CONTRIBUTING.md

Lines changed: 12 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -1,56 +1,12 @@
1-
# Contributing
2-
3-
We absolutely welcome any code contributions and we hope that this
4-
guide will facilitate an understanding of the ``ansys-tools-repo-sync`` code
5-
repository. It is important to note that while the ``ansys-tools-repo-sync`` software
6-
package is maintained by ANSYS and any submissions will be reviewed
7-
thoroughly before merging, we still seek to foster a community that can
8-
support user questions and develop new features to make this software
9-
a useful tool for all users. As such, we welcome and encourage any
10-
questions or submissions to this repository.
11-
12-
For contributing to this project, please refer to the [PyAnsys Developer's Guide].
13-
14-
[PyAnsys Developer's Guide]: https://dev.docs.pyansys.com/index.html
15-
16-
## Installation
17-
18-
Installing in developer mode allows you to modify the source and enhance it.
19-
20-
Before contributing to the project, please refer to the [PyAnsys Developer's guide](https://dev.docs.pyansys.com/). You will
21-
need to follow these steps:
22-
23-
1. Start by cloning this repository:
24-
25-
```bash
26-
git clone https://github.com/ansys/ansys-tools-repo-sync
27-
```
28-
29-
2. Create a fresh-clean Python environment and activate it:
30-
31-
```bash
32-
# Create a virtual environment
33-
python -m venv .venv
34-
35-
# Activate it in a POSIX system
36-
source .venv/bin/activate
37-
38-
# Activate it in Windows CMD environment
39-
.venv/Scripts/Activate.bat
40-
41-
# Activate it in Windows Powershell
42-
.venv/Scripts/Activate.ps1
43-
```
44-
45-
3. Install the project in editable mode:
46-
47-
```bash
48-
python -m pip install -e .
49-
```
50-
51-
## Raw testing
52-
53-
If required, you can always call the style commands ([black](https://black.readthedocs.io/en/stable/), [isort](https://pycqa.github.io/isort/),
54-
[flake8](https://flake8.pycqa.org/en/latest/)) or unit testing ones ([pytest](https://docs.pytest.org/en/stable/)) from the command line. However,
55-
this does not guarantee that your project is being tested in an isolated
56-
environment, which is the reason why tools like [tox](https://tox.readthedocs.io/en/latest/) exist.
1+
# Contribute
2+
3+
Overall guidance on contributing to a PyAnsys library appears in the
4+
[Contributing] topic in the *PyAnsys developer's guide*. Ensure that you
5+
are thoroughly familiar with this guide before attempting to contribute to
6+
{project-name}.
7+
8+
The following contribution information is specific to the ``ansys-tools-repo-sync`` repository.
9+
10+
[Contributing]: https://dev.docs.pyansys.com/how-to/contributing.html
11+
12+
<!-- Begin content specific to your library here. -->

0 commit comments

Comments
 (0)