Merge pull request #4 from rgbayrak/main

added contributors guide and code of conduct

CODE_OF_CONDUCT.md

@@ -0,0 +1,41 @@
+# Code of Conduct for the PhysAI Project
+
+## 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.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at *[email protected]*. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 1.4, available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

CONTRIBUTING.md

@@ -0,0 +1,45 @@
+# Contributing to PhysAI
+
+We're thrilled that you're interested in contributing to the PhysAI project! This document provides guidelines for contributions to ensure a smooth collaboration process.
+
+## How to Contribute
+
+Contributions can come in many forms, from submitting a bug report or feature request in the issues, to updating documentation or writing code. Here’s how you can contribute:
+
+### Reporting Bugs or Issues
+
+If you encounter a problem with any of the tools or the website, please submit an issue via the GitHub issue tracker. Please include:
+
+- A clear and descriptive title.
+- A detailed description of the problem.
+- Steps to reproduce the issue.
+- Expected and actual outcomes.
+- Any additional context or screenshots that might be helpful.
+
+### Suggesting Enhancements
+
+We welcome suggestions for improvements or new features. Please submit an enhancement request through the issue tracker with the following information:
+
+- A clear and descriptive title.
+- A detailed description of the proposed feature or improvement.
+- Explain why this enhancement would be useful to the project.
+- Any additional context, such as examples or mock-ups.
+
+### Pull Requests
+
+Ready to contribute code or documentation? Here’s how to submit a good pull request:
+
+1. **Fork the Repository**: Start by forking the repository and then cloning it locally to make your changes.
+2. **Create a Branch**: Create a branch in your fork for your changes. It's best to name the branch something descriptive.
+3. **Make Your Changes**: Add your changes to the branch, adhering to the coding conventions and documentation style of the project.
+4. **Test Your Changes**: Make sure your changes do not break the project. Update or add tests as necessary.
+5. **Write a Good Commit Message**: Include a concise, descriptive commit message. Mention any issues your commit addresses.
+6. **Submit a Pull Request**: Push your branch to your fork on GitHub and then submit a pull request to the main repository. Provide a descriptive title and a detailed description of your changes.
+
+## Code of Conduct
+
+By participating in this project, you agree to abide by its [Code of Conduct](CODE_OF_CONDUCT.md). Respectful collaboration is crucial to a productive environment.
+
+## Questions?
+
+If you have any questions about contributing, please reach out via email or through an issue on GitHub.