added contributing and code of conduct guidelines

CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# 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, caste, color, 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 email 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
+[INSERT CONTACT METHOD].
+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][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

CONTRIBUTING.md

@@ -0,0 +1,101 @@
+# Contribute to Rio
+
+Rio is an open-source project administered by the Rio team. We appreciate your interest and efforts to contribute to Rio. See the [LICENSE](https://github.com/rio-labs/rio/blob/dev/LICENSE.txt) licensing information. All work done is available on GitHub.
+
+We highly appreciate your effort to contribute, but we recommend you talking to a maintainer before spending a lot of time making a pull request that may not align with the project roadmap. Whether it is from the Rio team or contributors, every pull request goes through the same process.
+
+## Feature Requests
+
+Feature Requests by the community are highly encouraged. Feel free to submit a new one or upvote an existing feature request on [Github Discussions](https://github.com/rio-labs/rio/discussions/categories/feature-requests).
+
+## Code of Conduct
+
+This project, and everyone participating in it, are governed by Rio's Code of Conduct. By participating, you are expected to uphold it. Make sure to read the full text to understand which type of actions may or may not be tolerated.
+
+## Bugs
+
+Rio is using [GitHub issues](https://github.com/rio-labs/rio/issues) to manage bugs. We keep a close eye on them. Before filing a new issue, try to ensure your problem does not already exist.
+
+<hr style="border:2px solid gray">
+
+## Before Submitting a Pull Request
+
+The Rio core team will review your pull request and either merge it, request changes, or close it.
+
+### Contribution Prerequisites
+
+- You have [Python](https://www.python.org/) at `version 3.10 or higher` installed.
+- You have [Rye](https://rye-up.com/) at `version 0.33.0 or higher` installed.
+- You have [Node.js](https://nodejs.org/) at `version 20.0 or higher` installed.
+- You are familiar with [Git](https://git-scm.com/).
+
+**Before submitting your pull request** make sure the following requirements are fulfilled:
+
+- Fork the repository and create your new branch from `dev`.
+- Run `rye sync` in the root of the repository.
+- Run `rye run dev-build` in the root of the repository.
+- Make sure `pre-commit hooks` are installed by running `python -m pre_commit install`.
+- If your contribution fixes an existing issue, please make sure to link it in your pull request.
+
+### Project structure
+
+- `frontend/` - TypeScript code for the Rio frontend
+- `raw-icons` - In addition to the official material icons, Rio ships with some
+  of its own. This directory contains any and all custom icons.
+- `rio/` - Python code for the Rio backend
+- `scripts/` - Contains scripts which are tangentially related to Rio, but not
+  used during runtime. For example, you can find benchmarking and publishing
+  scripts here
+- `tests/` - Contains tests for Rio
+
+## Development Workflow
+
+While Rio allows users to write apps in 100% Python, Rio itself has both a
+Python and a TypeScript component. In order to get started using Rio from the
+repository, you'll have to build the typescript Component as well.
+
+### 1. Fork the repository
+
+[Go to the repository](https://github.com/rio-labs/rio) and fork it using your own GitHub account.
+
+### 2. Clone the repository
+
+```bash
+git clone git@github.com:YOUR_USERNAME/rio.git
+```
+
+### 3. Install dependencies
+
+Go to the root of the repository and run the setup:
+
+```bash
+cd rio
+rye sync
+rye run dev-build
+python -m pre_commit install
+```
+
+Rye and npm don't get along well on windows. If the build command above fails,
+try to build directly using `npm`:
+
+```bash
+npm run dev-build
+```
+
+## Miscellaneous
+
+### Repository Organization
+
+We chose to use a monorepo design. This allows us to maintain the whole ecosystem keep it up-to-date and consistent.
+
+We do our best to keep the dev branch as clean as possible, with tests passing at all times. However, the dev branch can move faster than the release cycle. Therefore check the releases on [PyPI](https://pypi.org/project/rio-ui/) so that you are always up-to-date with the latest stable version.
+
+### Reporting an issue
+
+Before submitting an issue, please check the existing issues to see if your issue has already been reported. If it has, please add a comment to the existing issue instead of creating a new one.
+
+- You are experiencing a technical issue with Rio.
+- Your issue title is concise, on-topic, and polite.
+- You provide steps to reproduce the issue.
+- Make sure the issue template is respected.
+- Make sure your issue body is readable and [well formatted](https://docs.github.com/de/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).