diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml index fec5ce4..356c97b 100644 --- a/.github/FUNDING.yml +++ b/.github/FUNDING.yml @@ -1,6 +1,6 @@ # These are supported funding model platforms -github: Foadsf +github: [Foadsf] patreon: fsfarimani open_collective: # Replace with a single Open Collective username ko_fi: # Replace with a single Ko-fi username diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..030fcc8 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,124 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, religion, or sexual identity and +orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our +community include: + +* Demonstrating empathy and kindness toward other people +* Being respectful of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +* Focusing on what is best not just for us as individuals, but for the + overall community + +Examples of unacceptable behavior include: + +* The use of sexualized language or imagery, and sexual attention or + advances of any kind +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or email + address, without their explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +Community leaders 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, and will communicate reasons for moderation +decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official e-mail address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement at f.s.farimani@gmail.com. +All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series of +actions. + +**Consequence**: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or +permanent ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including +sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within +the community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 2.1, available at +[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1]. + +Community Impact Guidelines were inspired by +[Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity). + +[homepage]: https://www.contributor-covenant.org +[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..0904ae3 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,66 @@ +# Contributing to NXOpen Python Tutorials + +First off, thanks for taking the time to contribute! + +The following is a set of guidelines for contributing to the NXOpen Python Tutorials repository. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request. + +## How Can I Contribute? + +### Reporting Bugs + +This section guides you through submitting a bug report for the NXOpen Python Tutorials. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports. + +- **Use a clear and descriptive title** for the issue to identify the problem. +- **Describe the exact steps to reproduce the problem** in as many details as possible. +- **Provide specific examples** to demonstrate the steps. + +### Suggesting Enhancements + +This section guides you through submitting an enhancement suggestion for the NXOpen Python Tutorials, including completely new features and minor improvements to existing functionality. + +- **Use a clear and descriptive title** for the issue to identify the suggestion. +- **Provide a step-by-step description of the suggested enhancement** in as much detail as possible. +- **Explain why this enhancement would be useful** to most users. + +### Contributing Examples + +We welcome new NXOpen Python examples! If you have code snippets or full scripts that demonstrate how to automate tasks in Siemens NX using Python, please share them. + +1. **Fork the repository** on GitHub. +2. **Clone your fork** locally: + ```bash + git clone https://github.com/YOUR_USERNAME/NXOpen_Python_tutorials.git + cd NXOpen_Python_tutorials + ``` +3. **Create a new branch** for your contribution: + ```bash + git checkout -b meaningful-branch-name + ``` +4. **Add your example** to the `Examples/` folder. Please use a naming convention consistent with existing files (e.g., `ex000X.py`) if applicable, or a descriptive name. +5. **Update the README** to include documentation for your new example. +6. **Commit your changes** with a clear commit message: + ```bash + git commit -m "Add example for creating a block feature" + ``` +7. **Push to your fork**: + ```bash + git push origin meaningful-branch-name + ``` +8. **Submit a Pull Request** on GitHub to the main repository. + +## Styleguides + +### Python Styleguide + +- We follow [PEP 8](https://www.python.org/dev/peps/pep-0008/). +- Please ensure your code is readable and well-commented. +- Use meaningful variable and function names. + +### Documentation Styleguide + +- Use Markdown for documentation. +- When adding an example, please update the main `README.md` with a brief description and, if possible, a screenshot in the `Pictures/` directory. + +## License + +By contributing, you agree that your contributions will be licensed under the [CC0 1.0 Universal](LICENSE) (Public Domain) license.