Skip to content

Commit 379a92a

Browse files
CHORE: Update missing or outdated files (#911)
* chore: update CODE_OF_CONDUCT.md file * chore: update CONTRIBUTING.md file * Adapt contributing file --------- Co-authored-by: Dominik Gresch <[email protected]> Co-authored-by: Dominik Gresch <[email protected]>
1 parent 9d595f2 commit 379a92a

File tree

3 files changed

+79
-18
lines changed

3 files changed

+79
-18
lines changed

CODE_OF_CONDUCT.md

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
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: 7 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,10 @@
1-
# Contributing
1+
# Contribute
22

3-
<!-- START_MARKER_FOR_SPHINX_DOCS -->
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+
PyACP.
47

5-
We absolutely welcome all code contributions and hope that this
6-
guide facilitates an understanding of the PyACP code
7-
repository. It is important to note that while the PyACP software
8-
package is maintained by Ansys and any submissions are reviewed
9-
thoroughly before merging, we still seek to foster a community that can
10-
support user questions and develop new features to make this software
11-
a useful tool for all users. As such, we welcome and encourage any
12-
questions or submissions to this repository.
8+
[Contributing]: https://dev.docs.pyansys.com/how-to/contributing.html
139

14-
<!-- END_MARKER_FOR_SPHINX_DOCS -->
15-
16-
For comprehensive documentation on contributing to the PyACP project,
17-
refer to the [PyAnsys developer's guide](https://dev.docs.pyansys.com).
10+
Contributing information specific to PyACP can be found in the [Contributing topic](https://acp.docs.pyansys.com/version/stable/contributing.html) in the *PyACP documentation*.

doc/source/contributing.rst

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,13 @@
33
Contribute
44
==========
55

6-
7-
.. include:: ../../CONTRIBUTING.md
8-
:start-after: <!-- START_MARKER_FOR_SPHINX_DOCS -->
9-
:end-before: <!-- END_MARKER_FOR_SPHINX_DOCS -->
6+
We absolutely welcome all code contributions and hope that this guide facilitates
7+
an understanding of the PyACP code repository. It is important to note that while
8+
the PyACP software package is maintained by Ansys and any submissions are reviewed
9+
thoroughly before merging, we still seek to foster a community that can support
10+
user questions and develop new features to make this software a useful tool for
11+
all users. As such, we welcome and encourage any questions or submissions to this
12+
repository.
1013

1114
For example, you can make contributions as follows:
1215

0 commit comments

Comments
 (0)